Skip to main content
GET
Filter Search Capabilities

Headers

x-api-key
string | null

Query Parameters

mode
string
default:company

Search mode: 'company' or 'people'.

refresh
boolean
default:false

Force a mapping refresh instead of using cached capabilities.

Response

Successful Response

Response describing supported filter-search DSL capabilities.

index_name
string
required

Public dataset identifier for company direct-filter queries.

fields
FilterFieldCapability · object[]
required

Unified per-field capabilities sorted alphabetically.

nested_paths
string[]
required

Allowed nested.path values for nested query clauses.

limits
FilterSearchLimits · object
required

Constraint values for guarded DSL validation.

cache_ttl_seconds
integer
required

Server cache TTL for mapping-derived capabilities.

generated_at_epoch_ms
integer
required

Epoch timestamp (ms) when these capabilities were derived.

mode
enum<string>
default:company

Search mode these capabilities apply to.

Available options:
people,
company
mapping_hash
string | null

Hash of mapping metadata used to derive this capability snapshot.

simple_query_operators
string[] | null

Supported MongoDB-style operators for simple_filters input.