<- Bookings API

Bookings API

List bookings

GET

 /v2/bookings

Retrieve a collection of bookings.

To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope. To call this endpoint with seller-level permissions, set APPOINTMENTS_ALL_READ and APPOINTMENTS_READ for the OAuth scope.

Permissions:APPOINTMENTS_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

limit

integer(32-bit)

The maximum number of results per page to return in a paged response.

Link to section

cursor

string

The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.

Link to section

customer_id

string

The customer for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.

Link to section

team_member_id

string

The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.

Link to section

location_id

string

The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.

Link to section

start_at_min

string

The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

start_at_max

string

The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after start_at_min is used.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

Response fields

Link to section

bookings

The list of targeted bookings.

Link to section

cursor

string

The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.

Max Length
65536
Link to section

errors

Errors that occurred during the request.