GET
/
contacts
/
properties
curl --request GET \
  --url https://api.getbrew.ai/v1/contacts/properties \
  --header 'Authorization: Bearer <token>'
[
  {
    "key": "firstName",
    "label": "First Name",
    "type": "string"
  },
  {
    "key": "lastName",
    "label": "Last Name",
    "type": "string"
  },
  {
    "key": "email",
    "label": "Email",
    "type": "string"
  },
  {
    "key": "userId",
    "label": "User ID",
    "type": "string"
  },
  {
    "key": "source",
    "label": "Source",
    "type": "string"
  },
  {
    "key": "subscribed",
    "label": "Subscribed",
    "type": "boolean"
  },
  {
    "key": "createdAt",
    "label": "Created At",
    "type": "date"
  },
  {
    "key": "companyName",
    "label": "Company Name",
    "type": "string"
  },
  {
    "key": "jobTitle",
    "label": "Job Title",
    "type": "string"
  },
  {
    "key": "teamSize",
    "label": "Team Size",
    "type": "number"
  },
  {
    "key": "isTrialUser",
    "label": "Is Trial User",
    "type": "boolean"
  }
]

Authorizations

​
Authorization
string
header
required

Include your Brew API key as a Bearer token in the Authorization header.

Example: Authorization: Bearer bw_api_your_key_here

Query Parameters

​
list
enum<string>
default:all

Filter properties by type - 'all' returns everything, 'custom' returns only your custom properties

Available options:
all,
custom

Response

200
application/json

Contact properties retrieved successfully. Use these property keys when creating or updating contacts.

For detailed information about creating and using custom properties, see our Custom Properties documentation.

The response is of type object[].