Look up report filter values

POST/v2/reports/filter-values

Returns the available values for a filterable attribute — use it to build valid filters rules for POST /v2/reports/query.

Works for attributes whose values live in your workspace data (tags, teammates, teams, companies, plans, countries, …). Attributes with staticOptions in the catalog don’t need this endpoint — their value set is already inline.

query narrows results by search string
selectedValues resolves labels for values you already hold (returned alongside search results)

Example

{ "fieldId": "conversation.tags", "query": "bill", "limit": 20 }

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer, and only for workspaces with the Reports product enabled (404 otherwise).

Header ParametersExpand Collapse

"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

Body ParametersJSONExpand Collapse

fieldId: string

Attribute ID to look up values for (must have valueSource: "remote_search" or static options in the catalog).

minLength1

maxLength512

limit: optional number

Maximum number of options to return (1-50, default 20).

minimum1

maximum50

query: optional string

Optional search string to narrow the returned options.

maxLength255

selectedValues: optional array of string

Already-selected values to resolve labels for (returned alongside search results).

ReturnsExpand Collapse

data: array of ReportAttributeOption { label, value }

label: string

value: string

object: "list"

Look up report filter values

curl https://do.featurebase.app/v2/reports/filter-values \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY" \
    -d '{
          "fieldId": "conversation.tags",
          "query": "bill"
        }'

{
  "data": [
    {
      "label": "label",
      "value": "value"
    }
  ],
  "object": "list"
}

Returns Examples

{
  "data": [
    {
      "label": "label",
      "value": "value"
    }
  ],
  "object": "list"
}