v1

latestOpenAPI 3.1.02026-07-261450274.9 KB

Get Bookings

Retrieve a list of bookings.

get/bookings

Query parameters

pageinteger

Page number

branchesinteger[]

List of Location IDs

idsinteger[]

List of Booking IDs

statusesinteger[]

Array of Booking status IDs

assigneesinteger[]

Array of employee IDs

clients_idsinteger[]

List of client (person / organization) IDs

client_namesstring[]

List of client (person / organization) names

client_phonesstring[]

List of phone numbers

created_atstring[]

Filter by creation date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

modified_atstring[]

Filter by modification date. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

scheduled_forstring[]

Filter by "Scheduled from" date and time. Accepts an array with one or two ISO 8601 date-time values. If one value is provided, it represents the start (left) boundary. If two values are provided, they define a date range (start and end). Examples: ["2025-05-01T00:00:00Z"] — filter from May 1, 2025 onward. ["2025-05-01T00:00:00Z", "2025-05-02T00:00:00Z"] — filter between May 1 and May 2, 2025.

sort'id' | '-id' | 'modified_at' | '-modified_at' | 'scheduled_for' | '-scheduled_for'

Defines the sorting order of returned results. Use a field name to sort ascending or prefix it with a minus sign (-) to sort descending.

Response

200

object required