Bulk retrieve team member booking profiles

POST

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

Retrieves one or more team members' booking profiles.

Permissions:APPOINTMENTS_BUSINESS_SETTINGS_READ

Try in API Explorer

Link to section

Request body

Example code

Link to section

team_member_ids

string [ ]

Required

A non-empty list of IDs of team members whose booking profiles you want to retrieve.

Min Length

Max Length

Link to section

Response fields

Link to section

team_member_booking_profiles

The returned team members' booking profiles, as a map with team_member_id as the key and TeamMemberBookingProfile the value.

Link to section

errors

Errors that occurred during the request.

Link to section

Examples

POST /v2/bookings/team-member-booking-profiles/bulk-retrieve

curl https://connect.squareup.com/v2/bookings/team-member-booking-profiles/bulk-retrieve \
  -X POST \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "team_member_ids": [
      "TMaJcbiRqPIGZuS9",
      "TMXUrsBWWcHTt79t",
      "TMtdegug1fqni3wh"
    ]
  }'

Response JSON

{
  "team_member_booking_profiles": {
    "TMaJcbiRqPIGZuS9": {
      "team_member_booking_profile": {
        "team_member_id": "TMaJcbiRqPIGZuS9",
        "display_name": "Sandbox Staff 1",
        "is_bookable": true
      },
      "errors": []
    },
    "TMXUrsBWWcHTt79t": {
      "errors": [
        {
          "category": "INVALID_REQUEST_ERROR",
          "code": "NOT_FOUND",
          "detail": "Resource not found."
        }
      ]
    },
    "TMtdegug1fqni3wh": {
      "team_member_booking_profile": {
        "team_member_id": "TMtdegug1fqni3wh",
        "display_name": "Sandbox Staff 2",
        "is_bookable": true
      },
      "errors": []
    }
  },
  "errors": []
}