List Entity Type Field Distinct Values
List the values a filter on one field of an entity type can take: the distinct values in use for a text, unique or entity reference field, or every option of an enum or multi-select field. Use it to find the exact stored value before filtering, because a text filter compares against the stored text and a guessed value matches nothing. The list covers the entity type’s own records, not those of its child types; list a child type separately. List without search first; pass search, a case-insensitive match on text fields, only when the list runs past one page.
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.
- 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
Path Parameters
Query Parameters
Response
Success
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.

