Forms Data Structures
Field definitions for key objects returned by Forms APIs.
|
ID Format
Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).
See global ID conventionsForm object
Object representing a form.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Form ID |
object | string | Required | Object type (`forms.form`) |
organization_id | string | Required | Organization ID |
title | string | Required | Form title |
status | "draft" | "published" | "archived" | Required | Status |
schema_json | string | Required | Form schema (JSON) |
created_at | string | Required | Created at (ISO 8601) |
updated_at | string | Required | Updated at (ISO 8601) |
{
"id": "form_01JQ3KXYZ",
"object": "forms.form",
"organization_id": "org_01HZXYZ",
"title": "Customer Satisfaction Survey",
"status": "published",
"schema_json": "{\"fields\":[{\"type\":\"text\",\"label\":\"Name\"}]}",
"created_at": "2026-02-01T09:00:00Z",
"updated_at": "2026-02-15T10:00:00Z"
}Response object
Object representing a form response.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Response ID |
object | string | Required | Object type (`forms.response`) |
form_id | string | Required | Form ID |
data | object | Required | Response data (JSON) |
submitted_at | string | Required | Submitted at (ISO 8601) |
{
"id": "resp_01JQ3KDEF",
"object": "forms.response",
"form_id": "form_01JQ3KXYZ",
"data": {
"name": "Tanaka Taro",
"rating": 5
},
"submitted_at": "2026-02-20T14:00:00Z"
}