Retrieves a bookings custom attribute.
GET
/v2/bookings/{booking_id}/custom-attributes/{key}
Retrieves a bookings custom attribute.
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.
The ID of the target booking.
Indicates whether to return the custom attribute definition in the definition
field of the custom attribute. Set this parameter to true
to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is false
.
The current version of the custom attribute, 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.