v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Contact Fields

List contact 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.

get/v1/fields

Query parameters

include'coverage'

Opt-in expansion: coverage adds per-field fill stats (percent of contacts with a non-empty value + top values).

audienceIdstring

Scope include=coverage stats to one saved audience (404 AUDIENCE_NOT_FOUND on an unknown / cross-brand id). Ignored without the include.

limitinteger

Page size (1–100). Defaults to 100.

cursorstring

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Response

A page of field definitions.