• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List customer custom attribute definitions

GET /v2/customers/custom-attribute-definitions

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.

Name Description
limit
integer (32-bit)

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.

cursor
string

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 Fields

Name Description
custom_attribute_definitions
CustomAttributeDefinition [ ]

The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object ({}).

cursor
string

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.

errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
GET /v2/customers/custom-attribute-definitions
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/customers/custom-attribute-definitions?limit=2 \
  -H 'Square-Version: 2022-09-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "custom_attribute_definitions": [
    {
      "key": "favoritemovie",
      "name": "Favorite Movie",
      "description": "Update the description as desired.",
      "version": 3,
      "updated_at": "2022-04-26T15:39:38Z",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
      },
      "created_at": "2022-04-26T15:27:30Z",
      "visibility": "VISIBILITY_READ_ONLY"
    },
    {
      "key": "ownsmovie",
      "name": "Owns Movie",
      "description": "Customer owns movie.",
      "version": 1,
      "updated_at": "2022-04-26T15:49:05Z",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean"
      },
      "created_at": "2022-04-26T15:49:05Z",
      "visibility": "VISIBILITY_HIDDEN"
    }
  ],
  "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH"
}