List library templates

GET

/templates

GET

/templates

1 curl https:/https://api/templates \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

1 {
2   "templates": [
3     {
4       "_id": "64b8f9a2e4b0c123456789ab",
5       "kind": "docx-liquid",
6       "formModality": "pdf-acroform",
7       "formFields": [
8         {
9           "fieldName": "fullName",
10           "fieldType": "text",
11           "required": true
12         }
13       ],
14       "detection": {
15         "keywords": [
16           "contract",
17           "agreement"
18         ],
19         "confidence": 0.95
20       },
21       "scope": "library",
22       "actionDefinitionId": null,
23       "slug": "nda-template-v1",
24       "name": "NDA Agreement Template",
25       "description": "A standard non-disclosure agreement template for new partners.",
26       "status": "draft",
27       "version": 1.1,
28       "file": {
29         "fileName": "nda_template_v1.docx",
30         "fileSize": 24576,
31         "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
32       },
33       "binding": {
34         "fullName": "{{user.fullName}}",
35         "date": "{{currentDate}}"
36       },
37       "variables": [
38         {
39           "name": "fullName",
40           "type": "string",
41           "description": "Full name of the signing party"
42         }
43       ],
44       "lint": {
45         "errors": [
46           {
47             "code": "missing_variable_description",
48             "message": "Variable 'date' is missing a description."
49           }
50         ],
51         "warnings": [
52           {
53             "code": "unused_variable",
54             "message": "Variable 'fullName' is declared but not used in the template."
55           }
56         ]
57       },
58       "sampleData": {
59         "fullName": "Jane Doe",
60         "date": "2024-06-01"
61       },
62       "archivedAt": null,
63       "createdAt": "2024-05-20T10:15:30Z",
64       "updatedAt": "2024-06-01T08:45:00Z",
65       "createdBy": "user_12345"
66     }
67   ]
68 }

Lists the org template library (library-scope rows only; action-scoped rows never appear). Optionally filter by archived state and lifecycle status.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Query parameters

archivedbooleanOptional

Include archived templates when true.

statusenumOptional

Filter the library to a single lifecycle status.

Allowed values:

Response

The library templates.

templateslist of objects

Errors

401

Unauthorized Error