Home/Scheduler/Data Structures

Scheduler Data Structures

Field definitions for key objects returned by Scheduler APIs.

ID Format

Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).

EventType object

Object representing a booking page type.

Fields

Name	Type	Required	Description
id	string	Required	Event type ID
object	string	Required	Object type (`scheduler.event_type`)
organization_id	string	Required	Organization ID
name	string	Required	Name
slug	string	Required	Slug (for URL)
duration_minutes	number	Required	Duration (minutes)
is_active	boolean	Required	Active flag
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (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

Object representing a booking.

Fields

Name	Type	Required	Description
id	string	Required	Booking ID
object	string	Required	Object type (`scheduler.booking`)
event_type_id	string	Required	Event type ID
guest_name	string	Required	Guest name
guest_email	string	Required	Guest email
start_time	string	Required	Start time (ISO 8601)
end_time	string	Required	End time (ISO 8601)
status	"confirmed" \| "cancelled" \| "rescheduled" \| "no_show"	Required	Status (confirmed, cancelled, rescheduled, no_show)
token	string	Required	Guest access token
created_at	string	Required	Created at (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

Object representing a scheduling proposal.

Fields

Name	Type	Required	Description
id	string	Required	Proposal ID
object	string	Required	Object type (`scheduler.proposal`)
organization_id	string	Required	Organization ID
title	string	Required	Title
status	"pending" \| "accepted" \| "expired"	Required	Status
token	string	Required	Guest access token
created_at	string	Required	Created at (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"
}