Skip to main content
GET
/
sign
/
envelopes
/
{envelopeID}
/
participants
List Participants by Envelope ID
curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/participants \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "<string>",
      "role": "<string>",
      "authentication": {
        "type": "AccessCode",
        "accessCode": "<string>"
      }
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique UUIDv4 string that identifies the envelope in the Nitro system.

Response

List participants

Fields

​
items
object[]

An array of participants associated with the package

​
total
integer<int32>

The total number of items available in the collection