list-booking-custom-attribute-definitions-response.md

List Booking Custom Attribute Definitions Response

Represents a ListBookingCustomAttributeDefinitions response. Either custom_attribute_definitions, an empty object, or errors is present in the response. If additional results are available, the cursor field is also present along with custom_attribute_definitions.

Structure

ListBookingCustomAttributeDefinitionsResponse

Fields

Name	Type	Tags	Description	Getter
CustomAttributeDefinitions	List<CustomAttributeDefinition>	Optional	The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object ({}).	List getCustomAttributeDefinitions()
Cursor	String	Optional	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.	String getCursor()
Errors	List<Error>	Optional	Any errors that occurred during the request.	List getErrors()

Example (as JSON)

{
  "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH",
  "custom_attribute_definitions": [
    {
      "created_at": "2022-11-16T15:27:30Z",
      "description": "Update the description as desired.",
      "key": "favoriteShampoo",
      "name": "Favorite shampoo",
      "schema": {
        "key1": "val1",
        "key2": "val2"
      },
      "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": {
        "key1": "val1",
        "key2": "val2"
      },
      "updated_at": "2022-11-16T15:49:05Z",
      "version": 1,
      "visibility": "VISIBILITY_HIDDEN"
    }
  ],
  "errors": []
}