List Fields

Returns both core contact fields and custom field definitions available for the current organization.

GET /v1/fields

List Fields

cURL

curl --request GET \
  --url https://brew.new/api/v1/fields \
  --header 'Authorization: Bearer <token>'

200

{
  "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

bearerAuthapiKeyAuth

Authorization · string · header · default: Bearer brew_your_api_key · required

Send your Brew API key as Authorization: Bearer brew_xxx.

Response

200

application/json

Field definitions for this organization.

fields · object[] · required

Show child attributes