get
https://api-sandbox.urbanpayx.com/api/v1/contracts/templates
List contract templates
Returns all contract template versions for the authenticated client.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Returns a paginated list of every contract template version belonging to the authenticated client, newest first. 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>. - The caller must hold the
contracts.templates.readpermission and have the OWNER, OPERATIONS, or DEVELOPER role. - The client must have contract signing enabled. If the feature is disabled the request returns
403.
Query parameters
| Parameter | Type | Default | Constraints |
|---|---|---|---|
page | integer | 1 | Must be >= 1 |
page_size | integer | 20 | Between 1 and 200 inclusive |
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, the uploadedsource_filemetadata, therolesandfieldsdefined on the template,detected_variables, andcreated_at/updated_at/published_attimestamps.pagination— object withtotal,page,page_size, andtotal_pages.
When the client has no templates, templates is an empty array and total is 0.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
422 | page or page_size fails validation (e.g. page < 1, page_size outside 1-200) |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.