Skip to content

Get Sync Job

GET
/integrations/crm-sync/jobs/{job_id}

How a bulk job is going.

Open-shaped: the payload carries per-provider progress detail that differs between CRMs and grows with them, so pinning it would drop whatever a provider reported that we had not caught up on.

Authorizations

Parameters

Path Parameters

job_id
required

Job id returned by a push or pull.

string

Job id returned by a push or pull.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

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
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