List merchant custom attribute definitionsBeta

GET

/v2/merchants/custom-attribute-definitions

Lists the merchant-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.

Permissions:MERCHANT_PROFILE_READ

Guide

List merchant custom attribute definitions

Try in API Explorer

Link to section

Query parameters

Example code

Link to section

visibility_filter

string

Filters the CustomAttributeDefinition results by their visibility values.

Link to section

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.

Link to section

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.

Link to section

Response fields

Link to section

custom_attribute_definitions

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

Link to section

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.

Link to section

errors

Any errors that occurred during the request.

Link to section

Examples

GET /v2/merchants/custom-attribute-definitions

curl https://connect.squareup.com/v2/merchants/custom-attribute-definitions?limit=2 \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "custom_attribute_definitions": [
    {
      "key": "has_seen_tutorial",
      "name": "NAME",
      "description": "Whether the merchant has seen the tutorial screen for using the app.",
      "version": 1,
      "updated_at": "2023-05-05T16:50:21.832Z",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean"
      },
      "created_at": "2023-05-05T16:50:21.832Z",
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    },
    {
      "key": "alternative_seller_name",
      "name": "Alternative Merchant Name",
      "description": "This is the other name this merchant goes by.",
      "version": 4,
      "updated_at": "2023-05-05T10:17:52.341Z",
      "schema": {
        "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
      },
      "created_at": "2023-05-05T19:06:36.559Z",
      "visibility": "VISIBILITY_READ_ONLY"
    }
  ],
  "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH"
}