Reference schemas
Booking
Section titled “Booking”| Field | Type | Description |
|---|---|---|
id | string | UUID |
startTime | string | Start date/time |
endTime | string | End date/time |
status | string | reserved, pending, confirmed, no_show, completed, cancelled |
internalNote | string | null | Internal note |
clientNote | string | null | Client note |
paymentStatus | string | null | Payment status |
isFromWeb | boolean | Created from minisite |
isFromAgent | boolean | Created by IA agent |
amount | number | Amount |
clientId | string | Client UUID |
locationId | string | Location UUID |
serviceId | string | Service UUID |
personId | string | null | Professional UUID |
paymentId | string | null | Payment UUID |
businessAccountId | string | Business UUID |
location | BookingLocation | null | Location summary |
person | BookingPerson | null | Professional summary |
service | BookingService | null | Service summary |
client | BookingClient | null | Client summary |
notifyClient | boolean | Notify client |
repeatGroupId | string | null | Repeat group UUID |
answers | array | null | Questionnaire answers |
questionaryId | string | null | Questionnaire UUID |
createdAt | string | null | Created at |
BookingLocation
Section titled “BookingLocation”| Field | Type | Description |
|---|---|---|
id | string | UUID |
name | string | Name |
BookingPerson
Section titled “BookingPerson”| Field | Type | Description |
|---|---|---|
id | string | UUID |
firstname | string | First name |
lastname | string | Last name |
email | string | |
status | string | Status |
phone | string | null | Phone |
BookingService
Section titled “BookingService”| Field | Type | Description |
|---|---|---|
id | string | UUID |
name | string | Name |
duration | integer | Duration in minutes |
domiciliary | boolean | At-home |
virtual | boolean | Virtual |
status | string | Status |
price | number | Price |
categoryId | string | Category UUID |
description | string | null | Description |
sessions | integer | null | Sessions |
simultaneous | integer | null | Simultaneous |
BookingClient
Section titled “BookingClient”| Field | Type | Description |
|---|---|---|
id | string | UUID |
firstname | string | First name |
lastname | string | Last name |
email | string | |
phone | string | Phone |
Client
Section titled “Client”| Field | Type | Description |
|---|---|---|
id | string | UUID |
firstname | string | First name |
lastname | string | Last name |
email | string | |
phone | string | Phone |
doc_type | string | null | Document type |
doc_number | string | null | Document number |
birthdate | string | null | Birthdate |
address | string | null | Address |
city | string | null | City |
state | string | null | State/Province |
country | string | null | Country |
business_account_id | string | Business UUID |
custom_fields | array | Custom field values |
TimeBlock
Section titled “TimeBlock”| Field | Type | Description |
|---|---|---|
id | string | UUID |
name | string | Name |
startTime | string | Start date/time |
endTime | string | End date/time |
locationId | string | Location UUID |
businessAccountId | string | Business UUID |
repetition | object | null | Repetition config |
providers | string[] | Professional UUIDs |
Webhook
Section titled “Webhook”| Field | Type | Description |
|---|---|---|
id | string | UUID |
url | string | Endpoint URL |
events | string[] | Subscribed events |
isActive | boolean | Whether active |
createdAt | string | Created at |
secret | string | Only on creation. Secret for signature verification |