Get List of Available Templates (GET /v2.0/templates/list?page={{page}}&pageSize={{pageSize}})
Get a list of the templates to which you have access rights.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| page | int | No | Which page number of the Template List to return. Defaults to 1. |
| pageSize | int | No | Number of objects to be returned per page. Must be between 1 and 100. Default is 10. |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned message |
Response Body Data Fields
| Field | Always Preset | Notes |
|---|---|---|
| list_info | Yes | List information object |
| page | Yes | Current page number |
| num_pages | Yes | Total number of pages available |
| num_results | Yes | Total number of records available |
| page_size | Yes | Records returned per page |
| templates | Yes | Templates array |
| template_id | Yes | Template ID |
| name | Yes | Template name |
| status | Yes | Template active status |
| creation_time_utc | Yes | Template creation time in UTC |
Sample Success Response
REQUEST:
curl --location --request GET 'api/v2.0/templates/list?page=1&pageSize=10' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9
RESPONSE:
{
"message": "",
"data": {
"list_info": {
|"page": 1,
"num_pages": 2,
"num_results": 12,
"page_size": 10
},
"templates": [
{
"template_id": "1bf364e9-cbe2-4cc0-8579-de2ff831cadf",
"name": "Test Document",
"status": "Inactive",
"creation_time_utc": "2021-11-16T07:21:07.283"
}
]
}
}
Sample Error Response
REQUEST:
curl --location --request GET 'api/v2.0/templates/list?page=1&pageSize=101' \
--header 'app_auth_type: jsign-oauth2' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9
RESPONSE:
{
"errors": [
{
"error_code": "PAGE_SIZE_EXCEEDED",
developer_message": "Exceeded page size limit, it should be between 1 to {PageSizeLimit}."
}
]
}
Note: View the full list of applicable error code for this method here.