ListBookings
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.
Query parameters
The maximum number of results per page to return in a paged response.
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.
The customer for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.
The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.
The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.
The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used.
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.
Response
Success
Example response
{
"bookings": [
{
"appointment_segments": [
{
"duration_minutes": 60,
"service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
"service_variation_version": 1599775456731,
"team_member_id": "TMXUrsBWWcHTt79t"
}
],
"created_at": "2020-10-28T15:47:41Z",
"customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M",
"customer_note": "",
"id": "zkras0xv0xwswx",
"location_id": "LEQHH0YY8B42M",
"seller_note": "",
"start_at": "2020-11-26T13:00:00Z",
"status": "ACCEPTED",
"updated_at": "2020-10-28T15:49:25Z",
"version": 1
}
],
"cursor": null,
"errors": []
}