Skip to content

Discover Crm Fields

GET
/integrations/crm/fields

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.

Authorizations

Parameters

Query Parameters

connection_id
required
string
entity_type

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.

string
default: contacts
Allowed values: 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.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
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.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string