List Bookings

get

https://{api_url}/api/v5/admin/{company_id}/bookings

Retrieves a list of bookings. Results are returned as a paginated list.

Path Params

company_id

int32

required

Query Params

start_date

string

Start date

end_date

string

End date

include_cancelled

boolean

Include cancelled

cancelled

boolean

Only get cancelled bookings

event_id

int32

Event ID

category_id

int32

Category ID

slot_id

int32

Time slot ID

start_time

string

Start time. 24 hour clock. Format: HH:mm. Start date is required.

end_time

string

End time. 24 hour clock. Format: HH:mm. End date is required.

modified_since

string

Only include bookings modified after this datetime. Format YYYY-MM-DDTHH:mm:ss

created_since

string

Only include bookings created after this datetime. Format YYYY-MM-DDTHH:mm:ss

string

Only include bookings created on this e-mail address

page

int32

Defaults to 1

per_page

int32

Defaults to 30

client_id

int32

person_id

int32

Staff member ID

resource_id

int32

Filter by resource ID

status

array of int32s

Valid Statuses: 0 - Booking Avaiblable, 1 - Booking Enquired, 2 - Booking Reserved, 4 - Booking Booked, 3 - Booking Blocked, 6 - Booking Cancelled, 8 - Booking Waitlisted

status

filter_by

string

filter_by_fields

string

order_by

string

order_by_reverse

boolean

purchase_id

int32

Purchase total ID

embed

string

A comma separated list of resources to embed. Available: address

children

boolean

Show all bookings of companies that belong to parent

Response

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Booking Collection