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",
"template_id": "RealEstate_001",
"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": {}
}
Field
Type
Description
id
string
The unique identifier (GUID) of the template
name
string
The name of the template
template_id
string
The template identifier (unique text identifier, max 20 characters)
description
string
Additional information or details about the template.
The type of control (e.g., "text", "number", "date", "radio", etc.)
path
string
The hierarchical path of the control within the template
label
string
The display label for the control
children_count
integer
The count of child controls nested within these controls
children
array
An array of control identifiers(GUIDs) 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 (nullable for root-level controls)
options
object
Control-specific options (structure varies by control type). Refer to control options section below.
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:
