Skip to main content
GET
/
v1
/
contacts
List contacts, count contacts, or look up one contact by email
curl --request GET \
  --url https://brew.new/api/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "contact": {
    "email": "jane@example.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "subscribed": true,
    "verificationStatus": "valid",
    "suppressed": false,
    "suppressedReason": null,
    "createdAt": 1712592000000,
    "updatedAt": 1712592300000,
    "importId": null,
    "customFields": {
      "plan": "enterprise",
      "revenue": 4200
    }
  }
}

Authorizations

​
Authorization
string
header
default:brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Query Parameters

​
email
string<email>

Look up a single contact by email address.

​
count
boolean
default:false

Return only the number of matching contacts.

​
search
string

Case insensitive search across email, first name, and last name.

Minimum string length: 1
​
limit
integer
default:50

Page size between 1 and 100.

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

Opaque pagination cursor returned from the previous list response.

​
sort
string
default:createdAt

Sort field. Use a core field or a custom field path like customFields.plan.

​
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
filter
object

Deep object filters. Use shorthand filter[subscribed]=true or explicit operators like filter[customFields.plan][eq]=enterprise. Use filter[_logic]=and|or|none to control filter combination.

Response

Lookup mode returns a single contact. Count mode returns a count. List mode returns contacts plus pagination.

​
count
integer
required
Required range: x >= 0