---
title: "Discover Crm Fields"
method: GET
path: "/integrations/crm/fields"
tags: ["Integrations"]
---

# Discover Crm Fields

`GET /integrations/crm/fields`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/integrations/crm/fields`
- Auth: HTTP bearer

The CRM's own fields for one object, including its custom ones.

This is where a valid `custom_fields[].field_name` comes from. The provider
rejects a name it does not have, so read this before writing one.

## Query parameters

- `connection_id` string, required
- `entity_type` 'contacts' | 'companies' | 'deals' | 'leads' | 'meetings' | 'tasks' | 'activities': Which CRM object to describe. `meetings`/`tasks` are Salesforce's Event/Task and `activities` is Pipedrive's; other providers fall back to contacts for an object they do not model.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseCrmCollection
  - `data` CrmCollection, required: A list of CRM records. A bare list from the app is surfaced as `items`; a named collection keeps its own key AND gains `items`, so a caller can page either shape without knowing which handler produced it.
    - `items` unknown[]
      - unknown
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)