Retrieves a custom attribute associated with a customer profile.
Open in API Reference
The ID of the target customer profile.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The key of the custom attribute to retrieve. This key must match the key of a custom attribute definition in the Square seller account. If the requesting application is not the definition owner, you must use the qualified key.
key
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.
definition
true
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.
BAD_REQUEST
// No response received yet.