GET /v2/envelopes

{
  "envelopes": [
    {
      "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
      "name": "Non disclosure agreement",
      "message": "Lorem ipsum dolor sit amet.",
      "status": "completed",
      "shared": false,
      "created": "2019-12-17T05:30:00Z",
      "sent": "2019-12-17T05:30:00Z",
      "voided": null,
      "declined": null,
      "completed": "2019-12-17T05:30:00Z",
      "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
      "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "recipients": [
        {
          "id": "255e591c2c9fe1bc99be1ec03075b402",
          "name": "Ted Annature",
          "email": "ted@annature.com.au",
          "mobile": "+61422000000",
          "type": "signer",
          "status": "completed",
          "message": "Lorem ipsum dolor sit amet.",
          "password": true,
          "muted": false,
          "order": 1,
          "declined_reason": null,
          "created": "2019-12-17T05:30:00Z",
          "sent": "2019-12-17T05:30:00Z",
          "declined": null,
          "completed": "2019-12-17T05:30:00Z",
          "redirects": {
            "session_completed": "https://..",
            "session_declined": "https://.."
          }
        }
      ]
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}
Returns a paginated list of envelopes associated with your organisation. Envelopes are sorted in descending order by creation date, with the most recently created appearing first. If multiple envelopes share the same timestamp, they are secondarily ordered by id to ensure consistent pagination. By default, envelopes with a status of draft are excluded unless the status parameter is explicitly provided. This endpoint supports the same filtering behavior as List all envelopes, with the addition of cursor-based pagination. To fetch the next page of results, pass the cursor value from the previous response. The has_more property indicates whether additional results are available. Date parameters must be in ISO 8601 format. Invalid dates are silently ignored.

​
Parameters

​
name
optional
Exact-match filter based on the envelope’s name property.
​
status
optional
Exact-match filter based on the envelope’s status.Valid values include draft, created, sent, completed, and voided.
​
recipient
optional
Exact-match filter based on a recipient’s name or email address.When used, all recipients of the matching envelopes will still be returned in the response.
​
group_id
optional
Return envelopes associated with the given group_id.
​
created_before
optional
Return envelopes created before the specified ISO 8601 timestamp.
​
created_after
optional
Return envelopes created after the specified ISO 8601 timestamp.
​
completed_before
optional
Return envelopes completed before the specified ISO 8601 timestamp.
​
completed_after
optional
Return envelopes completed after the specified ISO 8601 timestamp.
​
cursor
optional
Pagination cursor returned from a previous request. Use this to fetch the next page of results.
GET /v2/envelopes

{
  "envelopes": [
    {
      "id": "7e8f68e4c6df9395cd7ff48d69d7e2c1",
      "name": "Non disclosure agreement",
      "message": "Lorem ipsum dolor sit amet.",
      "status": "completed",
      "shared": false,
      "created": "2019-12-17T05:30:00Z",
      "sent": "2019-12-17T05:30:00Z",
      "voided": null,
      "declined": null,
      "completed": "2019-12-17T05:30:00Z",
      "account_id": "c64ce66b70b21c03bfd5dfa0ab14b730",
      "group_id": "a5a885caee6286a54ad7bbd4ab5400e9",
      "recipients": [
        {
          "id": "255e591c2c9fe1bc99be1ec03075b402",
          "name": "Ted Annature",
          "email": "ted@annature.com.au",
          "mobile": "+61422000000",
          "type": "signer",
          "status": "completed",
          "message": "Lorem ipsum dolor sit amet.",
          "password": true,
          "muted": false,
          "order": 1,
          "declined_reason": null,
          "created": "2019-12-17T05:30:00Z",
          "sent": "2019-12-17T05:30:00Z",
          "declined": null,
          "completed": "2019-12-17T05:30:00Z",
          "redirects": {
            "session_completed": "https://..",
            "session_declined": "https://.."
          }
        }
      ]
    }
  ],
  "cursor": "eyJpZCI6ImYxMjMiLCJjcmVhdGVkIjoiMjAyNS0wNy0wOVQwODozMDowMFoifQ==",
  "has_more": true
}