Skip to main content
GET
List Search filters and output fields

When to use this

Read /v1/search/fields before building a Search request. For every name it says which operators the name accepts in filters and whether it can be named in fields, so an agent can validate a query before paying for it. An unknown name in a Search request returns 422 search_invalid_filter. Enrich and Fetch have their own lists: GET /v1/enrich/fields and GET /v1/meta/fields. No authentication is required and the call is free. The response carries an ETag and Cache-Control: public, max-age=3600. Send If-None-Match with the last ETag to receive 304 Not Modified when nothing changed.

Request shape

GET with no body and no query parameters.

Example response

An excerpt: one filterable name and one output-only name are shown.

Response shape

Each entry has name, type, unit (null when unitless), description, interpretation_hints, null_meaning (null when not documented), nullable and source, plus:
  • filter_ops: operators the name accepts in filters. Text and boolean names take eq, ne and in; numbers and dates also take lt, lte, gt, gte and between; geometry takes intersects and within. An empty list means the name is output-only.
  • returnable: whether the name can be listed in the request’s fields.
Every request still needs a state2 filter with eq or in.

Errors

Response

Successful Response

fields
SearchDiscoveryField · object[]
required
pricing
EndpointPricing · object
required
version
string
required

Response envelope version.