Fields

Fields are the column definitions for contacts and companies. Use these endpoints to discover available fields — both built-in and custom — before importing or updating records.

---

List Contact Fields

GET /fields

Returns all contact field definitions, including base fields and any custom fields. Pass list_id to include list-specific custom fields.

Query Parameters

Parameter	Type	Default	Description
list_id	integer	—	Include custom fields specific to this list

Example

cURL

curl "https://be.graph8.com/api/v1/fields" \
  -H "Authorization: Bearer $API_KEY"

Python

response = requests.get(
    f"{BASE_URL}/fields",
    headers=HEADERS
)
fields = response.json()

TypeScript

const response = await fetch(`${BASE_URL}/fields`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
});
const fields = await response.json();

Response

{
  "data": [
    {
      "id": 1,
      "title": "First Name",
      "name": "CONTACT_FIRST_NAME",
      "data_type": "text",
      "is_global": true
    },
    {
      "id": 2,
      "title": "Work Email",
      "name": "CONTACT_WORK_EMAIL",
      "data_type": "text",
      "is_global": true
    },
    {
      "id": 150,
      "title": "Lead Score",
      "name": "custom_lead_score",
      "data_type": "number",
      "is_global": false
    }
  ]
}

---

List Company Fields

GET /fields/companies

Returns all company field definitions, including base fields and any custom fields.

Query Parameters

Parameter	Type	Default	Description
list_id	integer	—	Include custom fields specific to this list

Example

cURL

curl "https://be.graph8.com/api/v1/fields/companies" \
  -H "Authorization: Bearer $API_KEY"

Python

response = requests.get(
    f"{BASE_URL}/fields/companies",
    headers=HEADERS
)
fields = response.json()

TypeScript

const response = await fetch(`${BASE_URL}/fields/companies`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
});
const fields = await response.json();

Response

{
  "data": [
    {
      "id": 1,
      "title": "Company Name",
      "name": "COMPANY_NAME",
      "data_type": "text",
      "is_global": true
    },
    {
      "id": 2,
      "title": "Domain",
      "name": "COMPANY_DOMAIN",
      "data_type": "text",
      "is_global": true
    }
  ]
}