Retrieves a custom attribute associated with a customer profile.
GET
/v2/customers/{customer_id}/custom-attributes/{key}
Retrieves a custom attribute associated with a customer profile.
You can use the with_definition
query parameter to also retrieve the custom attribute definition in the same call.
To retrieve a custom attribute owned by another application, the visibility
setting must be 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
.
The ID of the target customer profile.
Indicates whether to return the custom attribute definition in the definition
field of the custom attribute. Set this parameter to true
to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is false
.
The current version of the custom attribute, 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.