---
title: "List contact fields"
method: GET
path: "/v1/fields"
tags: ["Contact Fields"]
---

# List contact fields

`GET /v1/fields`

Lists core contact columns and custom field definitions under `{ data, pagination }`. Use the field names in audience filters, contact search, and `{{ field | fallback }}` merge tags. Add `?include=coverage` to decorate each row with fill stats — the % of contacts holding a non-empty value plus the most common values (sampled; `approximate: true` on large populations) — and optionally `audienceId` to scope those stats to one saved audience. Check coverage before personalizing on a field so most recipients see a real value, not the fallback.

## Query parameters

- `include` 'coverage'
- `audienceId` string
- `limit` integer
- `cursor` string

## Response `200`

A page of field definitions.

- FieldsGetResponse
  - `data` object[], required
    - `fieldName` string, required
    - `fieldType` 'string' | 'number' | 'date' | 'bool', required
    - `label` string
    - `isCore` boolean
    - `isFilterable` boolean
    - `isSortable` boolean
    - `isSearchable` boolean
    - `coverage` object
      - `percent` integer, required
      - `approximate` boolean, required
      - `topValues` object[], required
        - `value` string, required
        - `count` integer, required
        - `percent` integer, required
      - `dominantValue` string
  - `pagination` object, required
    - `limit` integer, required
    - `cursor` string, nullable, required
    - `hasMore` boolean, required

## Other responses

- `400` — The request body or query string was invalid (unknown key, wrong type, or missing required field). Strict schemas reject unknown keys — including `brandId`, which is always resolved from the API key.
- `401` — The API key was missing, invalid, or revoked.
- `403` — The caller does not have the required `contacts` permission.
- `429` — The request hit the rolling rate limit window.
- `500` — Unexpected internal error.

---

[API](https://skmtc.net/brew/apis/brew-public-api-v1.md) · [All operations](https://skmtc.net/brew/apis/brew-public-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/brew/brew-public-api-v1/versions/db96cfedc6c5/schema)