Create Envelope List (POST /v2.0/envelopes/list)
Create a list of envelopes using a variety of data filters.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| status | Array | No |
Envelope status filter for envelope listing. |
| categories | Array | No | Envelope categories filter for envelope listing |
| start_date | String | No | Start date filter in mm/dd/yyyy format. |
| end_date | String | No | End date filter in mm/dd/yyyy format. |
| page | Integer | No | Page number value for pagination. |
| page_size | Integer | No | Page size value for pagination. |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| list_info[] | JSON Object |
Information for envelope list |
| list_info[].page | Yes | Current page number of the list |
| list_info[].num_pages | Yes | Number of pages in the list |
| list_info[].num_results | Yes | Total number of records in the list |
| list_info[].page_size | Yes | Current page size of the list |
| envelopes[] | Array | Array of envelope details |
| envelopes[].envelope_id | GUID | ID of envelope |
| envelopes[].name | String | Envelope name |
| envelopes[].status | String | Envelope status |
| envelopes[].created_by | String | Full name of the envelope creator |
| envelopes[].creations_time_utc | String | Date of envelope creation in UTC |
| envelopes[].categories | String | Categories of envelope |
Sample Success Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/list' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
--header 'Content-Type: application/json' \
--data-raw '{
"status" : ["AwaitingMySignature"],
"categories" : ["Agreement"],
"start_date" : "12/01/2021",
"end_date" : "12/01/2021",
"page" : 1,
"page_size" : 10
}'
RESPONSE:
{
"message": "",
"data": {
"list_info": {
"page": 1,
"num_page": 9,
"num_results": 90,
"page_size": 10
},
"envelopes": [
{
"envelope_id": "3755cdbe-31e5-47cf-9c81-ea7d5033f8ab",
"name": "Sample Envelope",
"status": "AwaitingMySignature",
"created_by": "UjjLimit Test",
"creation_time_utc": "2022-08-03T10:30:35.933",
"categories": " NDA, New Document"
}
]
}
}
}
Sample Error Response
REQUEST:
curl --location --request POST '/api/v2.0/envelopes/list' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
--header 'Content-Type: application/json' \
--data-raw '{
"status" : ["AwaitingMySignature"],
"categories" : ["Agreement"],
"start_date" : "12/01/2022",
"end_date" : "12/01/2021",
"page" : 1,
"page_size" : 10
}'
RESPONSE:
{
"errors": [
{
"error_code": "INVALID_START_DATE",
developer_message": "Start date should not be greater than End date."
}
]
}
Note: View the full list of applicable error code for this method here.