Skip to main content
GET
Get a contact field

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

Path Parameters

fieldName
string
required

The custom field name (URL-encoded when needed).

Minimum string length: 1
Example:

"plan"

Response

The field definition.

fieldName
string
required
Minimum string length: 1
fieldType
enum<string>
required
Available options:
string,
number,
date,
bool
label
string
isCore
boolean
isFilterable
boolean
isSortable
boolean
isSearchable
boolean
coverage
object