Skip to main content
GET
List contacts

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

Free-text search.

Minimum string length: 1
audienceId
string

Only members of this saved audience.

Required string length: 1 - 64
sort
string
default:createdAt
Minimum string length: 1
order
enum<string>
default:desc
Available options:
asc,
desc
limit
integer

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

Required range: 1 <= x <= 100
Example:

50

cursor
string
Required string length: 1 - 8192

Response

A page of contacts.

data
object[]
required
pagination
object
required