Skip to content

Get Crm Fields

GET
/crm-syncs/{provider}/fields

Discover available fields for an entity type on a CRM provider.

Authorizations

Parameters

Path Parameters

provider
required

CRM provider

string
Allowed values: hubspot salesforce pipedrive zoho sugarcrm

CRM provider

Query Parameters

entity_type

Entity type: contacts, companies, leads, deals

string
default: contacts

Entity type: contacts, companies, leads, deals

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
fields
Array<object>
object
label
Any of:
string
name
required
string
required
Any of:
boolean
slug
required
string
type
Any of:
string
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