List contract templates
Returns the reusable contract template versions for the authenticated
client. One-off templates (uploaded for a single send) are excluded unless
include_ad_hoc is true. Archived templates are excluded unless
include_archived is true or status=archived is passed.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns a paginated list of the reusable contract template versions belonging to the authenticated client, newest first. One-off templates (uploaded with ad_hoc=true for a single send) and archived templates are left out by default. Each entry includes the template status, source file metadata, detected signer roles, fields, and template variables. This is a read-only endpoint with no side effects.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - API credentials need the
contracts.templates.readpermission. Dashboard users need the OWNER, OPERATIONS, or DEVELOPER role, or a custom role that includes this permission. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Query parameters
All parameters are optional.
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Must be >= 1 |
page_size | integer | 20 | Between 1 and 200 inclusive |
q | string | - | Minimum length 1. Case-insensitive text match on the template name or the source filename. |
status | string | - | Return only templates with this status: published or archived (draft and failed are also accepted, but no template has those statuses). |
file_type | string | - | Return only templates of this source file type: pdf or docx. |
updated_from | date-time | - | Return templates updated at or after this timestamp. |
include_ad_hoc | boolean | false | Also return one-off templates uploaded for a single send. |
include_archived | boolean | false | Also return archived templates. Ignored when status is given. |
Filters are combined with AND. When status is given, only templates with that status are returned, so status=archived returns archived templates without include_archived. Results are ordered by creation time, newest first.
Response
200 - Returns an object with:
templates- array of template version objects. Each containsid,name,status,file_type,external_id,is_ad_hoc,signing_template_id,signing_template_slug, the uploadedsource_filemetadata, therolesandfieldsdefined on the template,detected_variables,variables_fillable, andcreated_at/updated_at/published_attimestamps.pagination- object withtotal,page,page_size, andtotal_pages.
When no templates match, templates is an empty array and total is 0.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
422 | A query parameter fails validation (e.g. page < 1, page_size outside 1-200, empty q, unknown status or file_type value, invalid updated_from timestamp) |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.