curl --request GET \
--url https://brew.new/api/v1/fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/fields"
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/fields', 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/fields",
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/fields"
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/fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/fields")
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{
"data": [
{
"fieldName": "email",
"fieldType": "string",
"label": "Email",
"isCore": true,
"isFilterable": true,
"isSortable": true,
"isSearchable": true
},
{
"fieldName": "plan",
"fieldType": "string",
"label": "Plan",
"isCore": false,
"isFilterable": true,
"isSortable": true,
"isSearchable": false,
"coverage": {
"percent": 62,
"approximate": true,
"topValues": [
{
"value": "scale",
"count": 610,
"percent": 51
},
{
"value": "starter",
"count": 420,
"percent": 35
}
],
"dominantValue": "scale"
}
}
],
"pagination": {
"limit": 100,
"cursor": null,
"hasMore": false
}
}List contact fields
Lists core contact columns and custom field definitions under { data, pagination }. Use the field names in audience filters, contact search, and {{ field | fallback }} merge tags. Add ?include=coverage to decorate each row with fill stats — the % of contacts holding a non-empty value plus the most common values (sampled; approximate: true on large populations) — and optionally audienceId to scope those stats to one saved audience. Check coverage before personalizing on a field so most recipients see a real value, not the fallback.
curl --request GET \
--url https://brew.new/api/v1/fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/fields"
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/fields', 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/fields",
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/fields"
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/fields")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/fields")
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{
"data": [
{
"fieldName": "email",
"fieldType": "string",
"label": "Email",
"isCore": true,
"isFilterable": true,
"isSortable": true,
"isSearchable": true
},
{
"fieldName": "plan",
"fieldType": "string",
"label": "Plan",
"isCore": false,
"isFilterable": true,
"isSortable": true,
"isSearchable": false,
"coverage": {
"percent": 62,
"approximate": true,
"topValues": [
{
"value": "scale",
"count": 610,
"percent": 51
},
{
"value": "starter",
"count": 420,
"percent": 35
}
],
"dominantValue": "scale"
}
}
],
"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 - 64Query Parameters
Opt-in expansion: coverage adds per-field fill stats (percent of contacts with a non-empty value + top values).
coverage Scope include=coverage stats to one saved audience (404 AUDIENCE_NOT_FOUND on an unknown / cross-brand id). Ignored without the include.
1 - 64Page 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?