SignatureAPI
Mint Starter Kit

Operations

List deliverables

Returns a list of all deliverables for an envelope.

GET
/ v1 / envelopes / {envelope_id} / deliverables

Returns a list of all deliverables for an envelope. Every completed envelope has at least one deliverable, created automatically when the envelope completes. Additional deliverables may exist if created via the Create Deliverable endpoint.

Results are sorted chronologically by creation date, with the earliest deliverable appearing first.

Path Parameters

​
envelope_id
string
required

The unique identifier of the envelope, in UUID format.

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 support.

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_...
// HTTP/1.1 200 OK
{
  "links": {
    "next": null,
    "previous": null
  },
  "data": [
    {
      "id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
      "name": null,
      "envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
      "type": "standard",
      "status": "generated",
      //...
    },
    {
      "id": "del_MYSExzUfKEWsXYnkywsAGQr",
      "name": "hr_pack",
      "envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
      "type": "simple",
      "status": "generated",
      //...
    }
  ]
}