Skip to content

Reference schemas

FieldTypeDescription
idstringUUID
startTimestringStart date/time
endTimestringEnd date/time
statusstringreserved, pending, confirmed, no_show, completed, cancelled
internalNotestring | nullInternal note
clientNotestring | nullClient note
paymentStatusstring | nullPayment status
isFromWebbooleanCreated from minisite
isFromAgentbooleanCreated by IA agent
amountnumberAmount
clientIdstringClient UUID
locationIdstringLocation UUID
serviceIdstringService UUID
personIdstring | nullProfessional UUID
paymentIdstring | nullPayment UUID
businessAccountIdstringBusiness UUID
locationBookingLocation | nullLocation summary
personBookingPerson | nullProfessional summary
serviceBookingService | nullService summary
clientBookingClient | nullClient summary
notifyClientbooleanNotify client
repeatGroupIdstring | nullRepeat group UUID
answersarray | nullQuestionnaire answers
questionaryIdstring | nullQuestionnaire UUID
createdAtstring | nullCreated at
FieldTypeDescription
idstringUUID
namestringName
FieldTypeDescription
idstringUUID
firstnamestringFirst name
lastnamestringLast name
emailstringEmail
statusstringStatus
phonestring | nullPhone
FieldTypeDescription
idstringUUID
namestringName
durationintegerDuration in minutes
domiciliarybooleanAt-home
virtualbooleanVirtual
statusstringStatus
pricenumberPrice
categoryIdstringCategory UUID
descriptionstring | nullDescription
sessionsinteger | nullSessions
simultaneousinteger | nullSimultaneous
FieldTypeDescription
idstringUUID
firstnamestringFirst name
lastnamestringLast name
emailstringEmail
phonestringPhone
FieldTypeDescription
idstringUUID
firstnamestringFirst name
lastnamestringLast name
emailstringEmail
phonestringPhone
doc_typestring | nullDocument type
doc_numberstring | nullDocument number
birthdatestring | nullBirthdate
addressstring | nullAddress
citystring | nullCity
statestring | nullState/Province
countrystring | nullCountry
business_account_idstringBusiness UUID
custom_fieldsarrayCustom field values
FieldTypeDescription
idstringUUID
namestringName
startTimestringStart date/time
endTimestringEnd date/time
locationIdstringLocation UUID
businessAccountIdstringBusiness UUID
repetitionobject | nullRepetition config
providersstring[]Professional UUIDs
FieldTypeDescription
idstringUUID
urlstringEndpoint URL
eventsstring[]Subscribed events
isActivebooleanWhether active
createdAtstringCreated at
secretstringOnly on creation. Secret for signature verification