Filter Search Capabilities

Get the fields, operators, and limits supported by filter search.

get/search/filter-capabilities

Request

modestring

Search mode: 'company' or 'people'.

refreshboolean

Force a mapping refresh instead of using cached capabilities.

x-api-keystring nullable

Successful Response

mode'people' | 'company'

Search mode these capabilities apply to.

index_namestring required

Public dataset identifier for company direct-filter queries.

nested_pathsstring[] required

Allowed nested.path values for nested query clauses.

cache_ttl_secondsinteger required

Server cache TTL for mapping-derived capabilities.

generated_at_epoch_msinteger required

Epoch timestamp (ms) when these capabilities were derived.

mapping_hashstring nullable

Hash of mapping metadata used to derive this capability snapshot.

simple_query_operatorsstring[] nullable

Supported MongoDB-style operators for simple_filters input.

No recorded changes to this operation across all 1 revision of this API.