Get a template

GET

/templates/:id

GET

/templates/:id

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

1 {
2   "template": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "kind": "docx-liquid",
5     "formModality": "pdf-acroform",
6     "formFields": [
7       {
8         "fieldName": "fullName",
9         "fieldType": "text",
10         "required": true,
11         "label": "Full Name"
12       }
13     ],
14     "detection": {
15       "keywords": [
16         "contract",
17         "agreement"
18       ],
19       "confidence": 0.95
20     },
21     "scope": "library",
22     "actionDefinitionId": "act-9876543210",
23     "slug": "nda-template",
24     "name": "NDA Agreement Template",
25     "description": "A standard non-disclosure agreement template for client engagements.",
26     "status": "draft",
27     "version": 1.1,
28     "file": {
29       "fileName": "nda_template.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": "The full name of the party signing the NDA."
42       }
43     ],
44     "lint": {
45       "errors": [
46         {
47           "code": "missing_variable",
48           "message": "Variable 'effectiveDate' is referenced but not defined."
49         }
50       ],
51       "warnings": [
52         {
53           "code": "deprecated_syntax",
54           "message": "Use of deprecated syntax in variable 'fullName'."
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-10T08:45:00Z",
65     "createdBy": "user_1234567890"
66   }
67 }

Returns a single template by id. Action-scoped rows are readable here (the action editor needs them).

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The template.

templateobject

Errors

401

Unauthorized Error

404

Not Found Error