Skip to main content
GET
/
sign
/
envelopes
/
{envelopeID}
/
documents
List Documents by Envelope ID
curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "ID": "987e6543-e21b-12d3-a456-426614174999",
      "name": "Document",
      "statue": "pending",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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 all documents associated with the envelope.

  • Pending
  • Uploaded
  • Failed
  • Signed
  • Sealed

Response for a pending document

​
name
string
required

Name of the file provided by the user.

Minimum string length: 1
​
ID
string<uuid>
required

Unique uuid identifier for the document.

Minimum string length: 1
​
createdAt
string<date-time>

UTC timestamp indicating when the document was created.

​
status
enum<string>

Current status of the document.

Available options:
pending,
uploaded,
failed,
signed,
sealed