curl --request GET \
--url https://brew.new/api/v1/domains/{domainId}/unsubscribes \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/domains/{domainId}/unsubscribes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/domains/{domainId}/unsubscribes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/domains/{domainId}/unsubscribes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/domains/{domainId}/unsubscribes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/domains/{domainId}/unsubscribes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/domains/{domainId}/unsubscribes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
"domainHost": "send.example.com",
"data": [
{
"email": "jane@example.com",
"scope": "domain",
"unsubscribedAt": "2026-09-17T09:12:00.000Z",
"source": "link",
"sendId": "kh7c1w2m3n4p5q6r7s8t9u0v1w2x3y4z"
}
],
"pagination": {
"limit": 100,
"cursor": null,
"hasMore": false
}
}List a domain's unsubscribes
Every MARKETING sending domain is its own unsubscribe list, keyed by the domain’s host inside the brand’s contacts. Returns one page ({ data, pagination }, newest first). Each row carries scope: domain (on this host’s list), all (the brand-wide opt-out — subscribed: false on the contact, which blocks every marketing send) or both. ?scope= narrows; ?q= searches by address. Transactional domains own no list → 422 DOMAIN_PURPOSE_NOT_ALLOWED.
curl --request GET \
--url https://brew.new/api/v1/domains/{domainId}/unsubscribes \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/domains/{domainId}/unsubscribes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/domains/{domainId}/unsubscribes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/domains/{domainId}/unsubscribes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/domains/{domainId}/unsubscribes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/domains/{domainId}/unsubscribes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/domains/{domainId}/unsubscribes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"domainId": "kx7bkh53hasmfeh5kd7sqgykt187g8ww",
"domainHost": "send.example.com",
"data": [
{
"email": "jane@example.com",
"scope": "domain",
"unsubscribedAt": "2026-09-17T09:12:00.000Z",
"source": "link",
"sendId": "kh7c1w2m3n4p5q6r7s8t9u0v1w2x3y4z"
}
],
"pagination": {
"limit": 100,
"cursor": null,
"hasMore": false
}
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
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.
1 - 64Path Parameters
Domain id (opaque Convex document id) returned by POST /v1/domains and listed by GET /v1/domains.
1 - 64"kx7bkh53hasmfeh5kd7sqgykt187g8ww"
Query Parameters
An address (anything with @) matches that address — exactly once complete, by prefix while partial. Other text is a word search over the address and the contact name.
320Which opt-outs to include: domain = this host’s list only, all = the brand-wide opt-out only, any (default) = either.
any, domain, all Page size (1–100). Defaults to 100.
1 <= x <= 100Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.
1 - 512Was this page helpful?