Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
BookingCustomAttributes

ListBookingCustomAttributes

Lists a booking's custom attributes.

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.

get/v2/bookings/{booking_id}/custom-attributes

Path parameters

booking_idstring required

The ID of the target booking.

Query parameters

limitinteger

The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see Pagination.

cursorstring

The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

with_definitionsboolean

Indicates whether to return the custom attribute definition in the definition field of each custom attribute. Set this parameter to true to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is false.

Response

Success

cursorstring

The cursor to use in your next call to this endpoint to retrieve the next page of results for your original request. This field is present only if the request succeeded and additional results are available. For more information, see Pagination.

Example response

{
  "custom_attributes": [
    {
      "created_at": "2022-11-16T15:50:27Z",
      "key": "favoriteShampoo",
      "updated_at": "2022-11-16T15:50:27Z",
      "value": "Hydro-Cool",
      "version": 1,
      "visibility": "VISIBILITY_READ_ONLY"
    },
    {
      "created_at": "2022-11-16T15:51:53Z",
      "key": "hasShoes",
      "updated_at": "2022-11-16T15:51:53Z",
      "value": false,
      "version": 1,
      "visibility": "VISIBILITY_HIDDEN"
    }
  ],
  "errors": []
}