<- Booking Custom Attributes API

Booking Custom Attributes API

All versions ->

List booking custom attribute definitions

GET

 /v2/bookings/custom-attribute-definitions

Get all bookings custom attribute definitions.

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

Query parameters

Example code

Link to section

limit

integer(32-bit)

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.

Link to section

cursor

string

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.

Link to section

Response fields

Link to section

custom_attribute_definitions

The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object ({}).

Link to section

cursor

string

The cursor to provide 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.

Link to section

errors

Any errors that occurred during the request.