Skip to main content
POST

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

Body

application/json
Minimum string length: 1
filters
object[]
audienceId
string
Minimum string length: 1
logic
enum<string>
default:and
Available options:
and,
or,
none
sort
string
default:createdAt
Minimum string length: 1
order
enum<string>
default:desc
Available options:
asc,
desc
count
boolean
default:false
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
Minimum string length: 1

Response

A page of matching contacts — or { count } when count: true.

data
object[]
required
pagination
object
required