• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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
Name Description
bookable_only
boolean

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

limit
integer (32-bit)

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

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.

location_id
string

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

Response Fields

Name Description
team_member_booking_profiles
TeamMemberBookingProfile [ ]

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.

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
errors
Error [ ]

Errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/bookings/team-member-booking-profiles
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/bookings/team-member-booking-profiles \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "team_member_booking_profiles": [
    {
      "team_member_id": "TMXUrsBWWcHTt79t",
      "display_name": "Sandbox Seller",
      "is_bookable": true
    },
    {
      "team_member_id": "TMaJcbiRqPIGZuS9",
      "display_name": "Sandbox Staff",
      "is_bookable": true
    }
  ],
  "errors": []
}