List custom dimension values

get

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/customdimensions/{definitionId}/values

Returns a paginated list of values for the given custom dimension definition. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the custom dimension definition is not found or has been deleted.

Path Params

organizationId

string

required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

definitionId

string

required

String. The ID of the custom dimension definition whose values to list, as returned in the id field of the GET definition response.

Query Params

searchText

string

String. Filters values by a partial, case-insensitive match on the display text.

sort

string

String. Sort order for the results. Format: field:direction. Supported fields: value, sortOrder, startDate, endDate. Supported directions: asc, desc. Defaults to sortOrder:asc.

locale

string

String. Locale code in language_REGION format (e.g. sv_SE, en_GB, de_DE). Only applies when sorting by value. Determines the collation used for alphabetical ordering of text values in natural sort. Defaults to sv_SE. Unknown locale codes fall back to Unicode ordering.

max

integer

1 to 1000

Defaults to 10

Integer. Maximum number of results to return per page.

offset

integer

≥ 0

Defaults to 0

Integer. Zero-based offset of the first result to return. Used for pagination.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

403Forbidden — organization not found or access denied

404Not found — custom dimension definition does not exist or has been deleted