Retrieve merchant custom attribute definitionBeta

GET

/v2/merchants/custom-attribute-definitions/{key}

Retrieves a merchant-related custom attribute definition from a Square seller account.

To retrieve a custom attribute definition created by another application, the visibility setting must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

Permissions:MERCHANT_PROFILE_READ

Guide

Retrieve merchant custom attribute definition

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

key

string

Required

The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.

Link to section

Query parameters

Link to section

version

integer(32-bit)

The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a BAD_REQUEST error.

Link to section

Response fields

Link to section

custom_attribute_definition

The retrieved custom attribute definition.

Link to section

errors

Any errors that occurred during the request.

curl https://connect.squareup.com/v2/merchants/custom-attribute-definitions/alternative_seller_name \ -H 'Square-Version: 2024-12-18' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -H 'Content-Type: application/json'

{ "custom_attribute_definition": { "key": "alternative_seller_name", "name": "Alternative Merchant Name", "description": "This is the other name this merchant goes by.", "version": 1, "updated_at": "2023-05-05T19:06:36.559Z", "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" } }