BookingCustomAttributes
ListBookingCustomAttributeDefinitions
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.
get/v2/bookings/custom-attribute-definitions
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.
Response
Success
Example response
{
"cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH",
"custom_attribute_definitions": [
{
"created_at": "2022-11-16T15:27:30Z",
"description": "Update the description as desired.",
"key": "favoriteShampoo",
"name": "Favorite shampoo",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
},
"updated_at": "2022-11-16T15:39:38Z",
"version": 3,
"visibility": "VISIBILITY_READ_ONLY"
},
{
"created_at": "2022-11-16T15:49:05Z",
"description": "Number of people in the party for dine-in",
"key": "partySize",
"name": "Party size",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Number"
},
"updated_at": "2022-11-16T15:49:05Z",
"version": 1,
"visibility": "VISIBILITY_HIDDEN"
}
],
"errors": []
}