Bulk retrieve bookings

POST

/v2/bookings/bulk-retrieve

Bulk-Retrieves a list of bookings by booking IDs.

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

Request body

Example code

Link to section

booking_ids

string [ ]

Required

A non-empty list of Booking IDs specifying bookings to retrieve.

Min Length

Max Length

Link to section

Response fields

Link to section

bookings

Requested bookings returned as a map containing booking_id as the key and RetrieveBookingResponse as the value.

Link to section

errors

Errors that occurred during the request.

curl https://connect.squareup.com/v2/bookings/bulk-retrieve \ -X POST \ -H 'Square-Version: 2024-10-17' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "booking_ids": [ "sc3p3m7dvctfr1", "tdegug1dvctdef", "tdegug1fqni3wh" ] }'

{ "bookings": { "sc3p3m7dvctfr1": { "booking": { "id": "sc3p3m7dvctfr1", "version": 0, "status": "ACCEPTED", "created_at": "2023-04-26T18:19:21Z", "updated_at": "2023-04-26T18:19:21Z", "location_id": "LY6WNBPVM6VGV", "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM", "start_at": "2023-05-01T14:00:00Z", "all_day": false, "appointment_segments": [ { "duration_minutes": 60, "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS", "team_member_id": "TMjiqI3PxyLMKr4k", "service_variation_version": 1641341724039, "any_team_member": false } ] }, "errors": [] }, "tdegug1dvctdef": { "errors": [ { "category": "INVALID_REQUEST_ERROR", "code": "NOT_FOUND", "detail": "Specified booking was not found.", "field": "booking_id" } ] }, "tdegug1fqni3wh": { "booking": { "id": "tdegug1fqni3wh", "version": 0, "status": "ACCEPTED", "created_at": "2023-04-26T18:19:30Z", "updated_at": "2023-04-26T18:19:30Z", "location_id": "LY6WNBPVM6VGV", "customer_id": "4TDWKN9E8165X8Z77MRS0VFMJM", "start_at": "2023-05-02T14:00:00Z", "all_day": false, "appointment_segments": [ { "duration_minutes": 60, "service_variation_id": "VG4FYBKK3UL6UITOEYQ6MFLS", "team_member_id": "TMjiqI3PxyLMKr4k", "service_variation_version": 1641341724039, "any_team_member": false } ] }, "errors": [] } }, "errors": [] }