<- Location Custom Attributes API

Location Custom Attributes API

All versions ->

List location custom attributesBeta

GET

 /v2/locations/{location_id}/custom-attributes

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:MERCHANT_PROFILE_READ

Guide

List location custom attributes

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

location_id

string

Required

Link to section

Query parameters

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

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.

Link to section

Response fields

Link to section

custom_attributes

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 ({}).

Link to section

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.

Link to section

errors

Any errors that occurred during the request.