Skip to main content
GET
List contact fields

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Query Parameters

include
enum<string>

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

Available options:
coverage
audienceId
string

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

Required string length: 1 - 64
limit
integer

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

Required range: 1 <= x <= 100
cursor
string

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

Required string length: 1 - 512

Response

A page of field definitions.

data
object[]
required
pagination
object
required