<- Bookings API

Bookings API

All versions ->

List team member booking profiles

GET

 /v2/bookings/team-member-booking-profiles

Lists booking profiles for team members.

Permissions:APPOINTMENTS_BUSINESS_SETTINGS_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

bookable_only

boolean

Indicates whether to include only bookable team members in the returned result (true) or not (false).

Link to section

limit

integer(32-bit)

The maximum number of results 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

location_id

string

Indicates whether to include only team members enabled at the given location in the returned result.

Link to section

Response fields

Link to section

team_member_booking_profiles

The list of team member booking profiles. The results are returned in the ascending order of the time when the team member booking profiles were last updated. Multiple booking profiles updated at the same time are further sorted in the ascending order of their IDs.

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.

Link to section

errors

Errors that occurred during the request.