<- Booking Custom Attributes API

Booking Custom Attributes API

Retrieve booking custom attribute definition



Retrieves a bookings custom attribute definition.

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.

Try in API Explorer
Link to section

Path parameters

Example code

Link to section




The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.

Link to section

Query parameters

Link to section



The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a BAD_REQUEST error.

Link to section

Response fields

Link to section


The retrieved custom attribute definition.

Link to section


Any errors that occurred during the request.