Get Form Template

GET

https://api.coperniq.io/v1/form-templates/:form_template_id

GET

/v1/form-templates/:form_template_id

1 const url = 'https://api.coperniq.io/v1/form-templates/1';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "id": 1,
3   "name": "string",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-01-15T09:30:00Z",
6   "assignee": {
7     "id": 1,
8     "firstName": "string",
9     "lastName": "string",
10     "email": "string"
11   },
12   "assigneeProperty": "string",
13   "collaborators": [
14     {
15       "id": 1,
16       "firstName": "string",
17       "lastName": "string",
18       "email": "string"
19     }
20   ],
21   "collaboratorProperties": [
22     "string"
23   ],
24   "labels": [
25     {
26       "id": 1,
27       "label": "string",
28       "color": "string"
29     }
30   ],
31   "dueDateXDaysAfter": 1,
32   "formLayouts": [
33     {
34       "id": 1,
35       "name": "string",
36       "type": "GROUP",
37       "columnId": 1,
38       "column": {
39         "id": 1,
40         "name": "string",
41         "type": "string",
42         "multiple": true,
43         "isRequired": true,
44         "isReadOnly": true
45       },
46       "properties": [
47         {
48           "id": 1,
49           "name": "string",
50           "type": "COLUMN",
51           "columnId": 1,
52           "column": {
53             "id": 1,
54             "name": "string",
55             "type": "string",
56             "multiple": true,
57             "isRequired": true,
58             "isReadOnly": true
59           }
60         }
61       ],
62       "fields": [
63         {
64           "id": 1,
65           "name": "string",
66           "type": "COLUMN",
67           "columnId": 1,
68           "column": {
69             "id": 1,
70             "name": "string",
71             "type": "string",
72             "multiple": true,
73             "isRequired": true,
74             "isReadOnly": true
75           }
76         }
77       ]
78     }
79   ]
80 }

Retrieve a specific form template by ID, including its full field layout.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

form_template_idintegerRequired

Form template identifier

Response

Form template details

idintegerOptional

Form template identifier

namestringOptional

Template name

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

assigneeobject or nullOptional

Direct user assignment. Null if assigneeProperty is used instead.

assigneePropertystring or nullOptional

Property-based assignee key. Returns a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property. Null if a direct user assignee is set.

collaboratorslist of objectsOptional

Direct user collaborators.

collaboratorPropertieslist of stringsOptional

Property-based collaborator keys. Each value is a standard key (OWNER, SALES_REP, PROJECT_MANAGER, CREATED_BY) or the keyName of a custom PERSON property.

labelslist of objectsOptional

dueDateXDaysAfterinteger or nullOptional

Number of days after creation that the form is due

formLayoutslist of objectsOptional

Top-level layout items (GROUP sections and standalone COLUMN fields). Only root-level items are returned; child items are nested inside each GROUP’s properties array.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error