FormsResponse
Response schema for a list of forms
data object[]required
When the form was created.
The number of fields in the form.
fields object[]nullable
The fields in the form when expanded.
Optional help text displayed below the field.
Unique identifier for the field.
Machine-readable key for the field. Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores.
Possible values: Value must match regular expression ^[a-z][a-z0-9_]*$
Display label for the field.
For boolean fields, whether the value must be true (e.g., consent checkboxes).
options objectnullable
Options configuration for choice-type fields.
- FieldOptions
- string
Whether to allow a free-text 'other' option.
choices object[]required
List of available choices.
Unique identifier for the choice.
Display label for the choice.
Display position of the field within the form.
Whether the field is required.
Whether the field contains sensitive data.
The field type.
Possible values: [short_text, long_text, email, phone, boolean, radio, select, checkbox]
Unique identifier for the form.
Possible values: Value must match regular expression ^frm_\w{12}$
The name of the form.
String representing the object's type.
Possible values: [form]
When the form was last updated.
meta objectrequired
Metadata for paginated responses
Current page number
Number of records per page
Total number of records
Total number of pages
{
"data": [
{
"created_at": "2025-02-17T17:49:19Z",
"field_count": 3,
"fields": null,
"id": "frm_d025a96ac0c6",
"internal_name": "Intake Form",
"object": "form",
"updated_at": "2025-02-17T17:49:19Z"
}
],
"meta": {
"current_page": 1,
"page_size": 10,
"total_count": 50,
"total_pages": 5
}
}