GET
/
v1
/
envelopes
// GET https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_0thJdKRhN4&limit=20",
    "previous": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_7yNl3c0t&limit=20"
  },
  "data": [
    {
      "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
      "title": "Dummy Agreement",
      // ...other envelope properties
    },
    {
      "id": "a72f0e-b919-4d69-89cd-e7e56af00531",
      "title": "Another Dummy Agreement",
      // ...other envelope properties
    },
    {
      "id": "b72f0e-b919-4d69-89cd-e7e56af00532",
      "title": "A Third Dummy Agreement",
      // ...other envelope properties
    },
  ]
}

Returns a list of the envelopes in the current account. The envelopes are sorted by creation date, with the most recently created envelopes appearing first.

The list of envelopes can be filtered by status.

​
Query Parameters

​
status
enum

Filter the list of envelopes by status.

Available options are draft, processing, in_progress, completed, failed, and canceled

​
topic
string

Filter the list of envelopes by topic.

​
limit
integer

The maximum number of objects to return in the response, up to 100. The default is 20.

​
Returns

Returns a 200 OK status code along with a paginated list of envelope objects if successful, or an error otherwise.

// GET https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...

{
  "links": {
    "next": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_0thJdKRhN4&limit=20",
    "previous": "https://api.signatureapi.com/v1/envelopes/?cursor=seq_7yNl3c0t&limit=20"
  },
  "data": [
    {
      "id": "55072f0e-b919-4d69-89cd-e7e56af00530",
      "title": "Dummy Agreement",
      // ...other envelope properties
    },
    {
      "id": "a72f0e-b919-4d69-89cd-e7e56af00531",
      "title": "Another Dummy Agreement",
      // ...other envelope properties
    },
    {
      "id": "b72f0e-b919-4d69-89cd-e7e56af00532",
      "title": "A Third Dummy Agreement",
      // ...other envelope properties
    },
  ]
}