v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

Bookings

BulkRetrieveBookings

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.

post/v2/bookings/bulk-retrieve

Request body

booking_idsstring[] required

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

Response

Success

bookingsobject

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

Example response

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