Appointments
The broker's calendar.
List appointments
Calendar appointments, earliest first. Use starts_after and starts_before to fetch a window, which is what a calendar sync wants; use updated_since to fetch only what changed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
starts_afterISO 8601 timestamp. Only appointments starting at or after it.
starts_beforeISO 8601 timestamp. Only appointments starting at or before it.
List appointments › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Create an appointment
The appointment is created on the calendar of the broker your key acts as. end_at must be after start_at.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Create an appointment › Request Body
titleRequired.
start_atISO 8601 start time. Required.
end_atISO 8601 end time. Must be after start_at. Required.
descriptionLonger detail.
locationFree-text location.
all_dayDefaults to false.
deal_idRelate the appointment to a deal in your brokerage.
conference_urlVideo call link.
Create an appointment › Responses
Success
successAlways true on a successful response.
The requested record.
Update an appointment
Only the fields you send are changed. An appointment synced from an external calendar returns 409 - edit it in the calendar that owns it, or the next sync overwrites your change.
path Parameters
idResource id.
Update an appointment › Request Body
titleRequired.
start_atISO 8601 start time. Required.
end_atISO 8601 end time. Must be after start_at. Required.
descriptionLonger detail.
locationFree-text location.
all_dayDefaults to false.
deal_idRelate the appointment to a deal in your brokerage.
conference_urlVideo call link.
Update an appointment › Responses
Success
successAlways true on a successful response.
The requested record.