Get Field Options (v1.2)

Returns the allowed values for one or more fields in a dataset, for use as filter values when querying data via "Get Data from Dataset (v2)". Pass field names in the fields array of the request body; the response is an object keyed by field name, where each value is an array of {id, value} option objects. Optionally supply filters to narrow the returned options (e.g. only options that exist for active employees) and dependentFields when one field's options depend on another field's selected value. Use "Get Fields from Dataset (v1.2)" to discover valid field names for a dataset.

Note: Compared to "Get Field Options (v1)", error responses (400, 403) use RFC 7807 application/problem+json format. Unrecognised field names may produce a 500 response with a plain-text body rather than structured JSON.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The name of the dataset you want to see field options for. Use "List Datasets (v1.2)" to discover available dataset names.

Body Params
fields
array of strings
required

List of field names to get options for

fields*
dependentFields
object | null

Dependent fields and their values that affect the options of the requested fields

filters
object | null

Optional filters to apply when retrieving field options. Filters limit the returned options based on other field values. The object contains a match key (all or any) and a filters array of objects with field, operator, and value keys.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

500

Internal server error. The response body may be plain text rather than a structured payload.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json