Skip to content

Pull All Contacts

POST
/integrations/crm-sync/contacts/pull

Pull every CRM contact into graph8.

enrich_from_graph8 SPENDS ENRICHMENT CREDIT when on. Omit it to take the app’s default rather than turning a spend on by accident.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Pull every CRM contact into graph8.

object
chunk_size
Any of:
integer
>= 1
connection_id
required

Which CRM connection to run against.

string
enrich_from_graph8
Any of:
boolean
entity_type
Any of:
string
limit
Any of:
integer
>= 1
list_id
Any of:
integer
max_parallel
Any of:
integer
>= 1

Responses

202

Successful Response

object
data
required

A bulk job, or its status. Open-shaped - the payload carries per-provider progress detail that differs between CRMs and grows with them.

object
job_id
Any of:
string
status
Any of:
string
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