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

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

GET /v2/customers/{customer_id}/custom-attributes

Lists the custom attributes associated with a customer profile.

You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call.

When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Permissions
CUSTOMERS_READ
Guide
List customer custom attributes Try in API Explorer

Path Parameters

Example code
Name Description
customer_id
string
Required

The ID of the target customer profile.

Query Parameters
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.
with_definitions
boolean

Indicates whether to return the custom attribute definition in the definition field of each custom attribute. Set this parameter to true to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is false.

Response Fields
Name Description
custom_attributes
CustomAttribute [ ]

The retrieved custom attributes. If with_definitions was set to true in the request, the custom attribute definition is returned in the definition field of each custom attribute.

If no custom attributes are found, Square returns an empty object ({}).
cursor
string

The cursor to use 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/{customer_id}/custom-attributes
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/customers/Z57QXKM2FGXEQDV42W8RBZY7BR/custom-attributes \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON 
{
  "custom_attributes": [
    {
      "key": "favoritemovie",
      "version": 1,
      "updated_at": "2022-04-26T15:50:27Z",
      "value": "Dune",
      "created_at": "2022-04-26T15:50:27Z",
      "visibility": "VISIBILITY_READ_ONLY"
    },
    {
      "key": "ownsmovie",
      "version": 1,
      "updated_at": "2022-04-26T15:51:53Z",
      "value": false,
      "created_at": "2022-04-26T15:51:53Z",
      "visibility": "VISIBILITY_HIDDEN"
    }
  ]
}