スケジューラ データ構造
スケジューラ API で返却される主要オブジェクトのフィールド定義です。
|
ID 形式
各リソースは prefix 付き public ID(例: deal_..., inv_..., form_..., ak_...)を利用します。
全プロダクト共通の ID 規約EventType object
予約ページの種類を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | イベントタイプ ID |
object | string | 必須 | オブジェクト種別(`scheduler.event_type`) |
organization_id | string | 必須 | 組織 ID |
name | string | 必須 | 名前 |
slug | string | 必須 | スラッグ(URL 用) |
duration_minutes | number | 必須 | 所要時間(分) |
is_active | boolean | 必須 | 有効フラグ |
created_at | string | 必須 | 作成日時 (ISO 8601) |
updated_at | string | 必須 | 更新日時 (ISO 8601) |
{
"id": "et_01JQ3KXYZ",
"object": "scheduler.event_type",
"organization_id": "org_01HZXYZ",
"name": "30-minute Meeting",
"slug": "30-min-meeting",
"duration_minutes": 30,
"is_active": true,
"created_at": "2026-01-10T09:00:00Z",
"updated_at": "2026-02-18T11:00:00Z"
}Booking object
予約を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 予約 ID |
object | string | 必須 | オブジェクト種別(`scheduler.booking`) |
event_type_id | string | 必須 | イベントタイプ ID |
guest_name | string | 必須 | ゲスト名 |
guest_email | string | 必須 | ゲストメール |
start_time | string | 必須 | 開始日時 (ISO 8601) |
end_time | string | 必須 | 終了日時 (ISO 8601) |
status | "confirmed" | "cancelled" | "rescheduled" | "no_show" | 必須 | ステータス(confirmed: 確定、cancelled: キャンセル、rescheduled: 日程変更、no_show: 欠席) |
token | string | 必須 | ゲストアクセストークン |
created_at | string | 必須 | 作成日時 (ISO 8601) |
{
"id": "bk_01JQ3KABC",
"object": "scheduler.booking",
"event_type_id": "et_01JQ3KXYZ",
"guest_name": "Suzuki Hanako",
"guest_email": "suzuki@example.com",
"start_time": "2026-02-25T10:00:00Z",
"end_time": "2026-02-25T10:30:00Z",
"status": "confirmed",
"token": "tok_guest_01JQ3KDEF",
"created_at": "2026-02-22T15:00:00Z"
}Proposal object
日程調整の提案を表すオブジェクトです。
フィールド
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 日程調整 ID |
object | string | 必須 | オブジェクト種別(`scheduler.proposal`) |
organization_id | string | 必須 | 組織 ID |
title | string | 必須 | タイトル |
status | "pending" | "accepted" | "expired" | 必須 | ステータス |
token | string | 必須 | ゲストアクセストークン |
created_at | string | 必須 | 作成日時 (ISO 8601) |
{
"id": "prop_01JQ3KGHI",
"object": "scheduler.proposal",
"organization_id": "org_01HZXYZ",
"title": "Team sync - March",
"status": "pending",
"token": "tok_prop_01JQ3KJKL",
"created_at": "2026-02-20T09:00:00Z"
}