Get contacts

The single “Get Contacts” read. Structured search over the brand’s contacts: free-text search, typed filters ({ field, operator, value } combined with logic: "and" | "or"), sort + order, and cursor pagination. Returns { data, pagination }.

Folds the former GET /v1/contacts (omit all filters to list everything) and GET /v1/contacts/{email} (use filters: [{ field: "email", operator: "equals", value: "…" }]).

Pass an optional audienceId to scope the search to a saved audience’s members — its stored filter is ANDed with filters (an unknown / cross-brand id → 400).

Set count: true to get { count } instead of a page.

POST /v1/contacts/search

cURL

filtered

curl --request POST \
  --url https://brew.new/api/v1/contacts/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "field": "plan",
      "operator": "equals",
      "value": "enterprise"
    }
  ],
  "sort": "createdAt",
  "order": "desc",
  "limit": 50
}
'

200

page

{
  "data": [
    {
      "email": "[e-mail]",
      "firstName": "Jane",
      "lastName": "Doe",
      "subscribed": true,
      "validationStatus": "valid",
      "verificationStatus": "valid",
      "suppressed": false,
      "suppressedReason": null,
      "createdAt": "2026-04-08T12:00:00.000Z",
      "updatedAt": "2026-04-08T12:05:00.000Z",
      "importId": null,
      "customFields": {
        "plan": "enterprise",
        "revenue": 4200
      }
    },
    {
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Smith",
      "subscribed": true,
      "validationStatus": "valid",
      "verificationStatus": "valid",
      "suppressed": false,
      "suppressedReason": null,
      "createdAt": "2026-04-08T12:00:00.000Z",
      "updatedAt": "2026-04-08T12:05:00.000Z",
      "importId": null,
      "customFields": {
        "plan": "starter"
      }
    }
  ],
  "pagination": {
    "limit": 50,
    "cursor": "eyJsYXN0SWQiOiIxMjMiLCJsYXN0U29ydCI6MTcxMjU5MjAwMDAwMH0=",
    "hasMore": true
  }
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · default: Bearer brew_your_api_key · required

Send your Brew API key as Authorization: Bearer brew_xxx.

Body

application/json

search · string

Minimum string length: 1

filters · object[]

Show child attributes

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

200

application/json

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

Option 1

Option 2

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes