---
title: "List Search filters and output fields"
method: GET
path: "/v1/search/fields"
---

# List Search filters and output fields

`GET /v1/search/fields`

## Request

- Base URL: `https://api.mireye.com`
- URL: `https://api.mireye.com/v1/search/fields`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mireye/apis/mireye-earth/docs/v1/search/fields/get.ts> (a function with typed inputs; its response is checked against the schema)

Every name accepted by POST /v1/search. filter_ops lists the operators a name accepts in filters (an empty list means output-only), and returnable says whether it may be named in fields. Includes type, unit, description, interpretation hints, null meaning, source and the Search price. No authentication is required. The response carries an ETag and Cache-Control: public, max-age=3600; send If-None-Match to receive 304 when nothing changed.

## Response `200`

Successful Response

- SearchFieldsResponse
  - `fields` SearchDiscoveryField[], required
    - `description` string, nullable, required
    - `filter_ops` string[], required: Operators this name accepts in filters. An empty list means the name is output-only.
    - `interpretation_hints` string, nullable, required: How to read the value.
    - `name` string, required: Field ID to use in requests.
    - `null_meaning` string, nullable, required: What a null value means, when documented.
    - `nullable` boolean, required: Whether a valid response can carry null.
    - `returnable` boolean, required: Whether the name is accepted in the fields list.
    - `source` string, nullable, required: Public source ID returned with values.
    - `type` string, required: Value type: string, int, float, bool, object or array.
    - `unit` string, nullable, required: Unit of the value, or null when unitless.
  - `pricing` EndpointPricing, required
    - `charged_when` string, required: When a request is charged.
    - `currency` 'USD', required
    - `plan_prices_usd` object, required: Price per unit on each plan, keyed by plan ID.
    - `price_usd` string, required: Price per unit on the Free plan, as a decimal string.
    - `unit` 'parcel' | 'query', required: What one charge covers.
  - `version` string, required: Response envelope version.

## Other responses

- `304`: Not modified; the cached copy matching If-None-Match is current.
- `400`: An unknown query parameter was supplied.

---

[API](https://skmtc.dev/mireye/apis/mireye-earth.md) - [All operations](https://skmtc.dev/mireye/apis/mireye-earth/llms.txt) - [OpenAPI document](https://skmtc.dev/mireye/apis/mireye-earth/revisions/d8410ba83654?raw)