Contacts
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
Request
- Base URLhttps://brew.new/api
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
A page of matching contacts — or { count } when count: true.
Changes
No recorded changes to this operation across all 1 revision of this API.