Skip to main content
GET
/
sign
/
envelopes
List Envelopes
curl --request GET \
  --url https://api.gonitro.dev/sign/envelopes \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "status": "drafted"
    }
  ],
  "nextPage": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
pageAfter
string

An optional cursor token that instructs the endpoint to return items following the last item from the previous response.

To use this field, include the token value from the nextPage field of the previous response in the pageAfter query parameter to retrieve the next batch of envelopes.

Example:

curl --location 'https://api.gonitro.dev/sign/envelopes?pageAfter=<next_page_token>'   --header 'Authorization: Bearer <your_jwt_token>'

Note: Cannot be used together with pageBefore.

​
pageBefore
string

An optional cursor token that instructs the endpoint to return items preceding the last item from the previous response.

To use this field, include the token from the nextPage field of the previous response in the pageBefore query parameter to retrieve envelopes before the cursor position.

Example:

curl --location 'https://api.gonitro.dev/sign/envelopes?pageBefore=<next_page_token>' --header 'Authorization: Bearer <your_jwt_token>'

Note: Cannot be used together with pageAfter.

Response

The List Envelopes endpoint returns all envelopes associated with your account. Envelopes are returned in an items array within the JSON response.

If additional envelopes are available, the initial response will include a nextPage field containing a string token. If there are no more envelopes, this field will be omitted. The token serves as a marker for the last item returned and can be used as the starting point for your next request.

The List Envelopes endpoint uses cursor-based pagination for optimal performance and consistency when handling large numbers of envelopes and frequent data updates.

Fields

​
items
object[]

An array of envelopes associated with the client's account.

​
nextPage
string

A cursor token indicating the position of the last item in the items array, used to retrieve the next page of results.

⌘I