Skip to main content
GET
/
v1
/
envelopes
/
{envelope_id}
/
deliverables
// GET https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables/?cursor=seq_0thJdKRhN4&limit=20",
    "previous": "https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables/?cursor=seq_7yNl3c0t&limit=20"
  },
  "data": [
    {
      "id": "del_3gGNgI0fTQ9o8Xn7epZQ8F",
      "status": "generated",
      "type": "standard",
      // ...other deliverable properties
    },
    {
      "id": "del_7hKMpL2gUZ1p9Yo8fqAR9G",
      "status": "generated",
      "type": "simple",
      // ...other deliverable properties
    },
    {
      "id": "del_9xTWnK4hVX2q0Zp9grBS0H",
      "status": "generated",
      "type": "simple",
      // ...other deliverable properties
    }
  ]
}
Returns a list of all deliverables for an envelope. The deliverables are sorted chronologically by creation date, with the earliest created deliverable appearing first.

​
Path Parameters

​
envelope_id
uuid
required
The unique identifier of the envelope.

​
Query Parameters

​
limit
integer
The maximum number of objects to return in the response, up to 20. The default is 20.
For certain use cases we can increase the limit. Please contact us at support@signatureapi.com.

​
Returns

Returns a 200 OK status code along with a paginated list of deliverable objects if successful, or an error otherwise. 
// GET https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables/?cursor=seq_0thJdKRhN4&limit=20",
    "previous": "https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables/?cursor=seq_7yNl3c0t&limit=20"
  },
  "data": [
    {
      "id": "del_3gGNgI0fTQ9o8Xn7epZQ8F",
      "status": "generated",
      "type": "standard",
      // ...other deliverable properties
    },
    {
      "id": "del_7hKMpL2gUZ1p9Yo8fqAR9G",
      "status": "generated",
      "type": "simple",
      // ...other deliverable properties
    },
    {
      "id": "del_9xTWnK4hVX2q0Zp9grBS0H",
      "status": "generated",
      "type": "simple",
      // ...other deliverable properties
    }
  ]
}