Skip to main content
GET
List Entity Type Field Distinct Values

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
  • Read the values of a field in a workspace’s database, or in a database shared with one of your workspaces: The permission is checked on the entity type’s owning workspace, or on a workspace its database is shared with (“Can read” or “Can write”). An entity type the caller cannot reach reads as not found. Schema, field and row-access rules still apply: a hidden or sensitive field is refused, and so is a caller limited to some of the type’s records when the field is a text, unique or entity reference field.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_type_id
string
required

The ID of the entity type. Readable in its owning workspace or through a workspace its database is shared with; an entity type the caller cannot reach reads as not found.

field_key
string
required

The key of a TEXT, UNIQUE, ENUM, MULTI_SELECT, BOOL or ENTITY_REF field on that entity type. A field whose values are hidden from the caller, or a sensitive field, is refused.

Query Parameters

Optional: narrows a TEXT field's values to those containing this text, ignoring case. Other field types ignore it. Costs more than a plain listing; use it when the listing runs past one page.

pageSize
integer<int32>

Maximum number of values to return. Default is 100, maximum is 1000. The options of an ENUM or MULTI_SELECT field always come back whole.

pageToken
string

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data
EntityTypeFieldDistinctValue · object[]

TEXT, UNIQUE and ENTITY_REF fields list the distinct values in use, in order; ENUM and MULTI_SELECT fields list every option. The values are those of this entity type's own records, archived ones included, not of its child types. For those three field types a caller whose access to the entity type is limited to some of its records is refused: no value could be tied to a record the caller may read.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results. A page can hold fewer values than page_size, even none, while more remain; keep paging while this is set.