Skip to content

List Crm Objects

GET
/integrations/crm/objects

The CRM objects this connection can see; unsupported rows carry the reason. Read-only.

Always 200 with an explicit status for known states: not_supported, reconnect_required (see missing_scopes) and access_denied. 404 until object sync is enabled for the organisation. Owner or Admin.

Authorizations

Parameters

Query Parameters

connection_id
required

The CRM connection id.

string
>= 1 characters <= 255 characters

The CRM connection id.

limit
integer
default: 100 >= 1 <= 200
offset
integer
<= 10000
custom_only
boolean
q
Any of:
string
<= 100 characters

Search the object names.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The CRM objects a connection can see, with an explicit status for unsupported or reconnect-needed states.

object
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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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