Form データ構造
Form API で返却される主要オブジェクトのフィールド定義です。
|
ID 形式
各リソースは prefix 付き public ID(例: deal_..., inv_..., form_..., ak_...)を利用します。
全プロダクト共通の ID 規約Form object
フォームを表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | フォーム ID |
object | string | 必須 | オブジェクト種別(`forms.form`) |
organization_id | string | 必須 | 組織 ID |
title | string | 必須 | フォーム名 |
status | "draft" | "published" | "archived" | 必須 | ステータス |
schema_json | string | 必須 | フォームスキーマ(JSON) |
created_at | string | 必須 | 作成日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (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
フォームへの回答を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 回答 ID |
object | string | 必須 | オブジェクト種別(`forms.response`) |
form_id | string | 必須 | フォーム ID |
data | object | 必須 | 回答データ(JSON) |
submitted_at | string | 必須 | 送信日時 (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"
}