Skip to main content
GET
/
v1
/
fields
List contact fields
curl --request GET \
  --url https://brew.new/api/v1/fields \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ],
  "pagination": {
    "limit": 100,
    "cursor": null,
    "hasMore": false
  }
}

Authorizations

​
Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Query Parameters

​
limit
integer

Page size (1–100). Defaults to 100.

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

Opaque pagination cursor echoed from the previous page’s pagination.cursor. Omit for the first page.

Required string length: 1 - 512

Response

A page of field definitions.

​
data
object[]
required
​
pagination
object
required