Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Datasets
Public API

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.

Use this endpoint when you already have dataset field names from get-fields-from-dataset-v1-2 and need valid filter/display options for those specific dataset fields. It is dataset-scoped: field names must be dataset field name values such as jobInformationDepartment, not account list aliases such as department.

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.

OAuth Scopes: field

post/api/v1_2/datasets/{datasetName}/field-options

Path parameters

datasetNamestring required

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

Request body

fieldsstring[] required

List of field names to get options for

dependentFieldsobject nullable

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

filtersobject nullable

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.

Example request

{
  "fields": [
    "field_name1",
    "field_name2"
  ],
  "dependentFields": {
    "field_name1": [
      {
        "field": "field_name2",
        "value": 123
      }
    ]
  },
  "filters": {
    "match": "all",
    "filters": [
      {
        "field": "employee_status",
        "operator": "includes",
        "value": [
          "Active"
        ]
      }
    ]
  }
}

Response

An object keyed by field name, where each value is an array of available option objects for that field.

object required