Shared shapes
11 shapes appear in the answers of more than one operation. A published name is never renamed. A caller ignores a field it does not know.
Account
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
handle
|
string | yes | |
handle_changed_at
|
string or null | yes | When the handle was last renamed. Null until the first rename. Limits: format date-time. |
handle_rename_allowed_at
|
string or null | yes | When an operator allowed one more rename before three months have passed. Null when no allowance is set. A successful rename clears it. Limits: format date-time. |
handle_rename_possible_from
|
string or null | yes | The first instant another rename is allowed, three calendar months after the last rename. Null until the first rename. An allowance does not move this instant. Limits: format date-time. |
name
|
string | yes | |
status
|
string | yes |
Values:
active
,
suspended
,
deleting
.
|
default_locale
|
string | yes | |
enabled_locales
|
array of string or null | yes | The languages the account's pages may be shown in. Null means the default language only. |
default_time_zone
|
string | yes | |
has_host_notice
|
boolean | yes | Whether a host gets an email when a booking is made, moved or canceled. |
has_cancel_calendar_file
|
boolean | yes | Whether a cancellation email carries the calendar file that removes the meeting from the visitor's calendar. |
has_calendar_sync
|
boolean | yes | Whether a host's own move, delete or decline of a booking's event in their calendar changes the booking (decision 0040). On by default. |
visitor_data_retention_days
|
integer | yes | How many days after a meeting ends its visitor's data is deleted (name, email, phone, answers, guests, and their copies in webhook events and the email log). The booking stays. 90 until changed; 30 to 730. |
embed_allowed_origins
|
array of string | yes | The sites that may show the account's booking pages in a frame, each an exact https origin. Empty: no site may. |
redirect_allowed_hosts
|
array of string | yes | The host names an event type's after-booking redirect may go to, each exact (www.example.com). Empty: no redirect is allowed. |
limit_cycle_start
|
string | yes | The Monday two-week limits are counted from, YYYY-MM-DD in the account's time zone, in fixed blocks of 14 days. A host may have its own. |
host_limit_defaults
|
array of object | yes | The default for each host's own booking limits, at most one for each period. A host's own limit for a period replaces it. |
host_limit_defaults[]
|
object | yes | |
host_limit_defaults[].id
|
string | yes | |
host_limit_defaults[].period
|
string | yes |
Values:
day
,
week
,
two_weeks
,
month
.
|
host_limit_defaults[].max_count
|
integer | yes | |
version
|
integer | yes |
Booking
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
version
|
integer | yes | |
start
|
string | yes | Limits: format date-time. |
end
|
string | yes | Limits: format date-time. |
visitor_time_zone
|
string or null | yes | |
event_type
|
object | yes | |
event_type.id
|
string | yes | |
event_type.name
|
string | yes | |
host
|
object | yes | |
host.id
|
string | yes | |
host.display_name
|
string | yes | |
hosts
|
array of object | yes | |
hosts[]
|
object | yes | |
hosts[].id
|
string | yes | |
hosts[].display_name
|
string | yes | |
hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
location
|
object | yes | |
location.kind
|
string | yes | |
location.value
|
string or null | yes | |
visitor
|
object | yes | |
visitor.name
|
string or null | yes | |
visitor.email
|
string or null | yes | |
visitor.phone
|
string or null | yes | |
guests
|
array of object | yes | The people the visitor invited besides themselves, in the order given. |
guests[]
|
object | yes | |
guests[].name
|
string or null | yes | |
guests[].email
|
string | yes | |
answers
|
array of object | yes | |
answers[]
|
object | yes | |
answers[].label
|
string | yes | |
answers[].kind
|
string | yes | |
answers[].text
|
string or null | yes | |
answers[].value
|
any | yes | |
calendar_event
|
object or null | yes | |
calendar_event.state
|
string | yes |
Values:
written
,
pending
,
failed
.
|
moved_from
|
object or null | yes | |
moved_from.start
|
string | yes | Limits: format date-time. |
moved_from.end
|
string | yes | Limits: format date-time. |
moved_to
|
object or null | yes | |
moved_to.start
|
string | yes | Limits: format date-time. |
moved_to.end
|
string | yes | Limits: format date-time. |
cancel_reason
|
string or null | yes | |
canceled_by
|
object or null | yes | |
canceled_by.type
|
string | yes |
Values:
visitor
,
member
,
api_key
,
host
,
system
,
calendar
.
|
canceled_by.id
|
string | no | |
external_ref
|
string or null | yes | The reference the booking was made with: the caller's own on POST /v1/bookings, or a prefilled link's. Null when none was given. |
requested_by
|
object or null | yes | Who asked for the booking in the system that minted its prefilled link, or made it through the API, as that system claims, and the member or key that made the claim. A hint, never authority. Null when none was given. |
requested_by.ref
|
string or null | yes | The issuing system's reference. Null once the visitor's data is removed. |
requested_by.issuer
|
object | yes | |
requested_by.issuer.type
|
string | yes |
Values:
member
,
api_key
.
|
requested_by.issuer.id
|
string | yes | |
reports
|
array of object | yes | What other systems reported they did with this booking, the latest report of each, by system name. Not a change to the booking. |
reports[]
|
object | yes | |
reports[].system
|
string | yes | |
reports[].version
|
integer | yes | |
reports[].sequence
|
integer | yes | |
reports[].status
|
string | yes |
Values:
done
,
skipped
,
failed
.
|
reports[].error_code
|
string or null | yes | |
reports[].external_id
|
string or null | yes | Null when none was given, and once the visitor's data is removed. |
reports[].failing_since
|
string or null | yes |
While status is failed: when this run of failed reports began. Repeated failures keep it.
Limits: format date-time.
|
reports[].reported_by
|
object | yes | |
reports[].reported_by.type
|
string | yes |
Values:
member
,
api_key
.
|
reports[].reported_by.id
|
string | yes | |
reports[].reported_at
|
string | yes | Limits: format date-time. |
routing
|
object or null | yes | |
routing.submission_id
|
string | yes | |
routing.answers
|
array of object | no | |
routing.answers[]
|
object | yes | |
routing.answers[].question_id
|
string | yes | |
routing.answers[].label
|
string | yes | |
routing.answers[].answer
|
string or array of string | yes |
BookingActivitySummary
| Field | Type | Always sent | Notes |
|---|---|---|---|
made_per_day
|
array of object | yes | |
made_per_day[]
|
object | yes | |
made_per_day[].date
|
string | yes | Limits: pattern ^\d{4}-\d{2}-\d{2}$. |
made_per_day[].count
|
integer | yes | Limits: at least 0. |
made_total
|
integer | yes | Limits: at least 0. |
made_total_previous
|
integer | yes | Limits: at least 0. |
upcoming_7_days
|
integer | yes | Limits: at least 0. |
average_lead_minutes
|
number or null | yes |
BookingLink
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
target_type
|
string | yes |
Values:
event_type
,
routing_form
,
host
,
redirect
.
|
event_type_id
|
string or null | yes | |
host_id
|
string or null | yes | |
routing_form_id
|
string or null | yes | |
redirect_url
|
string or null | yes | |
path
|
string | yes | |
url
|
string | yes | |
is_active
|
boolean | yes | |
inactive_redirect_url
|
string or null | yes | |
duplicate_rule
|
string | yes |
Values:
off
,
this_link
,
account
.
|
duplicate_match_phone
|
boolean | yes | |
is_canonical
|
boolean | yes | |
origin
|
string | yes |
Values:
system
,
member
,
rename
,
import
.
|
version
|
integer | yes | |
other_paths
|
array of string | yes | The other paths that open the same target. |
created_at
|
string | yes | Limits: format date-time. |
updated_at
|
string | yes | Limits: format date-time. |
BookingSummary
| Field | Type | Always sent | Notes |
|---|---|---|---|
created_at
|
string | yes | Limits: format date-time. |
id
|
string | yes | |
status
|
string | yes |
Values:
pending
,
confirmed
,
canceled
,
expired
.
|
outcome
|
string or null | yes |
Values:
attended
,
no_show
.
|
version
|
integer | yes | |
start
|
string | yes | Limits: format date-time. |
end
|
string | yes | Limits: format date-time. |
event_type
|
object | yes | |
event_type.id
|
string | yes | |
event_type.name
|
string | yes | |
host
|
object | yes | |
host.id
|
string | yes | |
host.display_name
|
string | yes | |
hosts
|
array of object | yes | |
hosts[]
|
object | yes | |
hosts[].id
|
string | yes | |
hosts[].display_name
|
string | yes | |
hosts[].role
|
string | yes |
Values:
organizer
,
co_host
.
|
visitor
|
object | yes | |
visitor.name
|
string or null | yes | |
visitor.email
|
string or null | yes |
EventType
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
name
|
string | yes | |
description
|
string or null | yes | |
kind
|
string | yes |
Values:
one_on_one
,
round_robin
,
collective
.
|
host_choice
|
string | yes |
Values:
link_only
,
visitor_picks
.
|
visibility
|
string | yes |
listed and unlisted: bookable on the booking addresses. api_only: bookable only through the API; every public path answers as for an event type that does not exist.
Values:
listed
,
unlisted
,
api_only
.
|
duration_min
|
integer | yes | |
slot_interval_min
|
integer or null | yes | |
min_notice_min
|
integer | yes | |
buffer_before_min
|
integer | yes | |
buffer_after_min
|
integer | yes | |
window_days
|
integer | yes | |
max_guests
|
integer | yes | |
schedule_id
|
string or null | yes | |
time_zone
|
string or null | yes | |
locale
|
string or null | yes | |
brand_id
|
string or null | yes | The brand the event type's pages and emails wear. Null: the account's default brand. |
confirmation_redirect_url
|
string or null | yes | Where the visitor is sent after a confirmed booking, as saved. It is used only while its host is still in the account's redirect_allowed_hosts. Null: none. |
invitee_notification
|
string | yes |
Values:
email
,
calendar_invite
,
both
.
|
visitor_notifications
|
object | yes | |
visitor_notifications.confirmation
|
boolean | yes | |
visitor_notifications.changes
|
boolean | yes | |
visitor_notifications.reminders
|
boolean | yes | |
reminder_offsets
|
array of integer | yes | |
tags
|
array of string | yes | |
position
|
integer | yes | |
counts_toward_host_limits
|
boolean | yes | |
counts_no_shows
|
boolean | yes | Whether a confirmed booking of this event type whose outcome is a no-show still counts toward every limit. |
reschedule_host
|
string | yes |
Read only on a round-robin event type: keep, a reschedule keeps the booking's host; any, a reschedule the own host cannot take goes to another pool host.
Values:
keep
,
any
.
|
is_active
|
boolean | yes | |
archived_at
|
string or null | yes | Limits: format date-time. |
version
|
integer | yes | |
created_at
|
string | yes | Limits: format date-time. |
updated_at
|
string | yes | Limits: format date-time. |
hosts
|
array of object | yes | |
hosts[]
|
object | yes | |
hosts[].host_id
|
string | yes | |
hosts[].schedule_id
|
string or null | yes | |
hosts[].priority
|
integer | yes | |
hosts[].weight
|
integer | yes | |
host_groups
|
array of object | yes | |
host_groups[]
|
object | yes | |
host_groups[].host_group_id
|
string | yes | |
host_groups[].priority
|
integer | yes | |
host_groups[].weight
|
integer | yes | |
pauses
|
array of object | yes | |
pauses[]
|
object | yes | |
pauses[].host_id
|
string | yes | |
pauses[].until_at
|
string or null | yes | When the pause ends. Null: until it is removed. Limits: format date-time. |
locations
|
array of object | yes | |
locations[]
|
object | yes | |
locations[].id
|
string | yes | |
locations[].kind
|
string | yes |
Values:
google_meet
,
microsoft_teams
,
phone
,
in_person
,
custom_text
.
|
locations[].value_source
|
string | yes |
Values:
fixed
,
host_profile
,
booker
.
|
locations[].value
|
string or null | yes | |
locations[].position
|
integer | yes | |
questions
|
array of object | yes | |
questions[]
|
object | yes | |
questions[].id
|
string | yes | |
questions[].label
|
string | yes | |
questions[].kind
|
string | yes |
Values:
short_text
,
long_text
,
single_choice
,
multi_choice
,
dropdown
,
phone
.
|
questions[].required
|
boolean | yes | |
questions[].options
|
array of string | yes | |
questions[].allow_other
|
boolean | yes | |
questions[].position
|
integer | yes | |
limits
|
array of object | yes | |
limits[]
|
object | yes | |
limits[].id
|
string | yes | |
limits[].kind
|
string | yes |
Values:
per_host
,
total
,
invitee_active
.
|
limits[].period
|
string or null | yes |
Null for invitee_active.
Values:
day
,
week
,
two_weeks
,
month
.
|
limits[].max_count
|
integer | yes | |
booking_urls
|
array of object | yes | The event type's public booking addresses. While visibility is api_only, each of them answers as for an event type that does not exist: book it through POST /v1/bookings. |
booking_urls[]
|
object | yes | |
booking_urls[].link_id
|
string | yes | |
booking_urls[].path
|
string | yes | |
booking_urls[].url
|
string | yes | |
booking_urls[].is_canonical
|
boolean | yes | |
booking_urls[].is_active
|
boolean | yes |
Host
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
member_id
|
string or null | yes | |
display_name
|
string | yes | |
email
|
string | yes | |
phone
|
string or null | yes | |
time_zone
|
string | yes | |
locale
|
string or null | yes | |
avatar_asset_key
|
string or null | yes | |
is_active
|
boolean | yes | |
archived_at
|
string or null | yes | Limits: format date-time. |
version
|
integer | yes | |
created_at
|
string | yes | Limits: format date-time. |
updated_at
|
string | yes | Limits: format date-time. |
limits
|
array of object | yes | The host's own booking limits across every event type that counts toward them, in the host's time zone. Each replaces the account's default for its period. |
limits[]
|
object | yes | |
limits[].id
|
string | yes | |
limits[].period
|
string | yes |
Values:
day
,
week
,
two_weeks
,
month
.
|
limits[].max_count
|
integer or null | yes | At most this many bookings in one period. Null: no limit in this period, whatever the account's default says. |
limit_cycle_start
|
string or null | yes | The Monday the host's two-week blocks are counted from, YYYY-MM-DD in the host's time zone. Null: the account's. |
external_ids
|
object | yes | The host's ids in other systems: an object from the system name the account chose to the id, names sorted; empty when there are none. Not part of the host's version: change one with setHostExternalId and removeHostExternalId. |
HostBusy
| Field | Type | Always sent | Notes |
|---|---|---|---|
host_id
|
string | yes | |
from
|
string | yes | Limits: format date-time. |
to
|
string | yes | Limits: format date-time. |
busy
|
array of object | yes | Busy spans in the range, earliest first, merged so that no two overlap or touch, in whole minutes and cut to the range. A span joins what blocks the host: every calendar the host has set to block time, the host's time off, and the account's own bookings and holds. |
busy[]
|
object | yes | |
busy[].start
|
string | yes | Limits: format date-time. |
busy[].end
|
string | yes | Limits: format date-time. |
Member
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
email
|
string | yes | |
name
|
string | yes | |
role
|
string | yes |
Values:
owner
,
admin
,
member
.
|
version
|
integer | yes | |
created_at
|
string | yes |
Schedule
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
host_id
|
string or null | yes | |
name
|
string | yes | |
time_zone
|
string | yes | |
is_default
|
boolean | yes | |
version
|
integer | yes | |
created_at
|
string | yes | Limits: format date-time. |
updated_at
|
string | yes | Limits: format date-time. |
hours
|
object | yes | |
hours.sunday
|
array of object | yes | |
hours.sunday[]
|
object | yes | |
hours.sunday[].start
|
string | yes | |
hours.sunday[].end
|
string | yes | |
hours.monday
|
array of object | yes | |
hours.monday[]
|
object | yes | |
hours.monday[].start
|
string | yes | |
hours.monday[].end
|
string | yes | |
hours.tuesday
|
array of object | yes | |
hours.tuesday[]
|
object | yes | |
hours.tuesday[].start
|
string | yes | |
hours.tuesday[].end
|
string | yes | |
hours.wednesday
|
array of object | yes | |
hours.wednesday[]
|
object | yes | |
hours.wednesday[].start
|
string | yes | |
hours.wednesday[].end
|
string | yes | |
hours.thursday
|
array of object | yes | |
hours.thursday[]
|
object | yes | |
hours.thursday[].start
|
string | yes | |
hours.thursday[].end
|
string | yes | |
hours.friday
|
array of object | yes | |
hours.friday[]
|
object | yes | |
hours.friday[].start
|
string | yes | |
hours.friday[].end
|
string | yes | |
hours.saturday
|
array of object | yes | |
hours.saturday[]
|
object | yes | |
hours.saturday[].start
|
string | yes | |
hours.saturday[].end
|
string | yes | |
overrides
|
array of object | yes | |
overrides[]
|
object | yes | |
overrides[].date
|
string | yes | |
overrides[].intervals
|
array of object | yes | |
overrides[].intervals[]
|
object | yes | |
overrides[].intervals[].start
|
string | yes | |
overrides[].intervals[].end
|
string | yes |
TimeOff
| Field | Type | Always sent | Notes |
|---|---|---|---|
id
|
string | yes | |
host_id
|
string | yes | |
start
|
string | yes | Limits: format date-time. |
end
|
string | yes | Limits: format date-time. |
origin
|
string | yes |
Values:
member
,
api
,
import
.
|
created_at
|
string | yes | Limits: format date-time. |
updated_at
|
string | yes | Limits: format date-time. |