List Documents by Envelope ID

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": [
    {
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "pending",
      "sizeBytes": 123,
      "numPages": 123,
      "failureReason": "<string>",
      "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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 documents

Fields

items

(Failed · object | Pending · object | Sealed · object | Signed · object | Uploaded · object)[]

An array of documents associated with the envelope.

Failed
Pending
Sealed
Signed
Uploaded

Show child attributes

Create Document by Envelope IDIn Nitro, a *Document* is a file that participants in an eSignature Envelope will read and sign. This could be an employment contract, NDA, legal agreement, banking form, or any other file required in your signature workflow. The Nitro Sign API accepts documents only in PDF format. The **Create Document by Envelope ID** endpoint supports uploading a **single** file per request. Every document must be part of an Envelope container. To upload a document, first [Create an Envelope](https://developers.gonitro.com/docs/api-reference/envelope/create-envelope) and retain the Envelope `ID`. When uploading a document, the following limits apply: - Maximum pages per document: 250 - Maximum size per document: 20Mb - Maximum documents per envelope: 15 - Maximum size per envelope: 300 Mb

⌘I

List Documents by Envelope ID

curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "pending",
      "sizeBytes": 123,
      "numPages": 123,
      "failureReason": "<string>",
      "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}