This API provides a variety of interfaces for working with your template data.
You should have the API Key while retrieving or updating your data. Without these API keys, you cannot access your templates.
Template Object
Top Level
{
"id": "5fda16a7-c870-4440-a1ef-1c560c6b65bd",
"name": "Real Estate Property Inspection",
"description": "Renters can use this template to inspect the property and collect data on the status of the property.",
"created_at": "2023-04-05T20:41:42.8660000Z",
"created_by": {},
"updated_at": "2023-04-05T20:41:42.8660000Z",
"updated_by": {},
"team": {},
"data": {}
}
| Key | Type | Description |
|---|---|---|
| id | String | A unique identifier for the template. |
| name | String | The name of the template. |
| description | String | Additional information or details about the template. |
| created_at | String | The date and time the template was created in ISO 8601 date and time format. |
| created_by | Object | General information about the user who created the template. |
| updated_at | String | The date and time the template was last updated in ISO 8601 date and time format. |
| updated_by | Object | General information about the user who last updated the template. |
| team | Object | General information about the team associated with the template. |
| data | Object | Template data object (template controls) |
Template data
{
"control_count": 6,
"controls": [{}]
}
| Key | Type | Description |
|---|---|---|
| controls | Array | The count of controls present in the template. |
| control_count | Number | An array of control object(s) representing individual control within the template. |
Control object
{
"id": "54a5a217-c261-48f5-8c40-8e85631d28b3",
"type": "text",
"path": "This is page 1/Section 1/",
"label": "Name of reporter?",
"children_count": 0,
"children": [],
"parent_id": "a7544213-c293-4db3-96e8-3c9b5c946e0c",
"options": {}
}
| Key | Type | Description |
|---|---|---|
| id | String | A unique identifier for the control. |
| type | String | The type of control. One of the following: page, section, text, number, radio, checkbox, dropdown, date, media, signature, barcode, checkin, instacount, instructions |
| path | String | The path or location within the template where this control is located. |
| label | String | The label or title of the control. |
| children_count | Number | The count of child controls nested within this control. |
| children | Array | An array of control identifiers representing individual child controls nested within this control. |
| parent_id | String | The identifier of the parent control if this control is nested within another control. |
| options | Object | Additional configurations or details specific to the control type. To understand the options object refer to control options. |
Control options
The control options object will include only fields relevant to the specific type of control. Below are all the possible options.
| Key | Type | Description |
|---|---|---|
| placeholder | String | A placeholder text that provides a hint or example of the expected input. |
| is_required | Boolean | A boolean value indicating whether the control is required. |
| show_media | Boolean | A boolean value indicating whether media attachments can be added to the control. |
| show_notes | Boolean | A boolean value indicating whether additional notes or comments can be added to the control. |
| allow_upload_photos | Boolean | A boolean value indicating whether users can upload photos or images as part of the control. |
| is_multiline | Boolean | This option is exclusively available for text control. It indicates whether the control allows multiple lines of text. |
| data_view | String | This option is exclusively available for the section control. It determines how the associated data should be displayed in the inspection report. |
| is_repeatable | Boolean | This option is exclusively available for the section control. It indicates whether the control can be repeated or duplicated. |
| choices | Array | An array containing predefined choices or responses for the control. |
| description | String | This option is exclusively available for instruction controls. It contains additional descriptive text or information intended to guide users or provide context within the inspection. Instruction controls typically display this information to users but do not require any input or response from them. |
| show_time | Boolean | This option is exclusively available for date controls. It indicates whether time selection is enabled for the control. |
To understand the available options for a specific control type, please refer to the table below:
| Control type | Available options |
|---|---|
| page | None, the option object will be empty |
| section | data_view and is_repeatable |
| text | placeholder, is_multiline, is_required, show_media, show_notes, allow_upload_photos |
| number | placeholder, is_required, show_media, show_notes, allow_upload_photos |
| radio | choices, is_required, show_media, show_notes, allow_upload_photos |
| checkbox | choices, is_required, show_media, show_notes, allow_upload_photos |
| dropdown | choices, is_required, show_media, show_notes, allow_upload_photos |
| date | show_time, is_required, show_media, show_notes, allow_upload_photos |
| media | is_required, show_notes, allow_upload_photos |
| signature | placeholder, is_required |
| barcode | is_required, show_media, show_notes, allow_upload_photos |
| checkin | is_required, show_media, show_notes, allow_upload_photos |
| instacount | is_required, show_media, show_notes, allow_upload_photos |
| instructions | description |