Signatures
Template List
Retrieves a list of all templates associated with the authenticated user.
- Supports filtering, sorting, and pagination via query parameters.
- Query Parameters:
- top (integer). Maximum number of templates to return (e.g., 25).
- skip (integer). Number of templates to skip in the sorted results (e.g., 0).
- sort (string). Column to sort by. Valid values: Template Name, Template Roles, Documents, Creation Date.
- order (string). Sort direction. Valid values: ASC, DESC.
- filter (JSON array). List of filter objects to refine results. Each filter includes:
- column (string). Field to filter on (matches sort values).
- condition (string). Filter condition.
- For stringFilter: EMPTY, NOT_EMPTY, CONTAINS, CONTAINS_CASE_SENSITIVE, DOES_NOT_CONTAIN, DOES_NOT_CONTAIN_CASE_SENSITIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, ENDS_WITH, ENDS_WITH_CASE_SENSITIVE, EQUAL, EQUAL_CASE_SENSITIVE, NULL, NOT_NULL.
- For dateFilter: EQUAL, NOT_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, NULL, NOT_NULL.
- value (string). Filter value.
- string for stringFilter.
- YYYY-MM-DD for dateFilter.
- type (string):
- stringFilter.
- dateFilter.
- key (string). Unique 12-character alphanumeric identifier for the filter.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Query Parameters
sort?string
Column to sort by the results.
Value in
- "Template Name"
- "Template Roles"
- "Documents"
- "Creation Date"
order?string
The direction of the sort.
Value in
- "ASC"
- "DESC"
top?integer
Max rows to return.
Default
100skip?integer
Rows to skip. Defaults to 0 if omitted or not a valid integer.
Default
0orderby?string
Single combined param, format "|<ASC|DESC>" (literal pipe). Defaults to UploadDate DESC if omitted or not recognized.
filter?string
URL-encoded JSON array of FilterInput objects. A folder-scoping filter (key="folder") can be used with the value "templates" to scope results to templates.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/signatures/template/list"{ "result": { "statusCode": 200, "message": "OK", "data": { "templates": [ { "id": "0ac4c6bd-2437-444e-b306-75ecfc09809e", "createdBy": { "id": "4e8d11f3-b0f8-4922-81a2-f6e903b5a863", "name": "Acme Corp Agreement.pdf", "email": "name@example.com" }, "status": "Completed", "uploadDate": "string", "sendDate": "string", "subject": "Please review and sign", "transactionTokenId": "b0f78bb3-4865-4624-afab-392d857d5325", "documents": "string", "recipients": "string", "signGroups": "string", "isSignOrder": true, "expireInDays": 0, "alertDaysBeforeExpiry": 0, "templateName": "NDA Template", "templateDescription": "Standard non-disclosure agreement template", "folderId": "1f69de4d-4e79-43fd-a8bd-edba83c8a995", "folderName": "Contracts" } ], "rowCount": 0 } }, "origin": "GET https://api.doctavian.com/v1/signatures/template/list", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "fe746017-ea1d-4d45-b4dc-3d7db9471166"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "GET https://api.doctavian.com/v1/signatures/template/list", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "9b1d9323-5eaa-4dd4-94a3-742708b88793", "operationId": "6be5fd86c7dc38f96dc1b260ccd523cd"}{ "error": { "message": "Envelope not found.", "statusCode": 500, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "GET https://api.doctavian.com/v1/signatures/template/list", "dateTime": "2026-07-20T12:00:00.000Z", "userId": "fc3f1465-360f-406e-b06c-06340407b370", "operationId": "4525a1843db5a56adadf8cc04ac72084"}