---
title: "List Enrich fields and presets"
method: GET
path: "/v1/enrich/fields"
---

# List Enrich fields and presets

`GET /v1/enrich/fields`

## Request

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

Every field ID and preset accepted by POST /v1/enrich, with type, unit, description, interpretation hints, null meaning, source and preset membership, plus the Enrich price. Use it to choose a small fields or preset selection before enriching a parcel. 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

- EnrichFieldsResponse
  - `fields` EnrichDiscoveryField[], required
    - `description` string, nullable, required
    - `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.
    - `presets` string[], required: Enrich presets that include this field.
    - `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.
  - `presets` EnrichDiscoveryPreset[], required
    - `description` string, required
    - `fields` string[], required: Exact fields the preset requests, in response order.
    - `name` string, required
  - `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)