ListCustomerCustomAttributeDefinitions
Lists the customer-related custom attribute definitions that belong to a Square seller account.
When all response pages are retrieved, the results include all custom attribute definitions that are visible to the requesting application, including those that are created by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. Note that seller-defined custom attributes (also known as custom fields) are always set to VISIBILITY_READ_WRITE_VALUES.
Query parameters
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.
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-04-26T15:27:30Z",
"description": "Update the description as desired.",
"key": "favoritemovie",
"name": "Favorite Movie",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
},
"updated_at": "2022-04-26T15:39:38Z",
"version": 3,
"visibility": "VISIBILITY_READ_ONLY"
},
{
"created_at": "2022-04-26T15:49:05Z",
"description": "Customer owns movie.",
"key": "ownsmovie",
"name": "Owns Movie",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean"
},
"updated_at": "2022-04-26T15:49:05Z",
"version": 1,
"visibility": "VISIBILITY_HIDDEN"
}
]
}