Skip to content

List Crm Lists

GET
/integrations/crm/lists

Lists in the CRM.

Published as GET although the app spells it POST: every one of its parameters is a QUERY parameter and it reads. A POST that takes no body is a read wearing the wrong verb, and publishing it that way would put this behind a write grant for no reason.

Authorizations

Parameters

Query Parameters

connection_id
required
string
query
Any of:
string

Filter by list name.

limit
integer
default: 50 >= 1 <= 250
offset
integer
entity_type

Which object the list holds.

string
default: contacts
Allowed values: contacts companies deals leads

Which object the list holds.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One CRM record, or one provider response.

Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer’s own data from them.

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