Skip to main content
GET
/
v1
/
fields
List contact field definitions
curl --request GET \
  --url https://brew.new/api/v1/fields \
  --header 'Authorization: Bearer <token>'
{
  "fields": [
    {
      "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
    }
  ]
}

Authorizations

​
Authorization
string
header
default:brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Response

Field definitions for this organization.

​
fields
object[]
required