List location custom attributes

Beta

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

Lists the custom attributes associated with a location.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the Developer Console Sign In

Parameters

location_id

The ID of the target location.

string

visibility_filter

Filters the CustomAttributeDefinition results by their visibility values.

string

Select visibility_filter

ALL All custom attributes or custom attribute definitions.
READ All custom attributes or custom attribute definitions with the visibility field set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
READ_WRITE All custom attributes or custom attribute definitions with the visibility field set to VISIBILITY_READ_WRITE_VALUES.

limit

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.

integer

cursor

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.

string

with_definitions

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.

boolean

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums