Skip to main content
POST
Request a Sync

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection_id
string
required

Response

Successful Response

created_at
string<date-time>
required
modified_at
string<date-time> | null
required
id
string
required
status
enum<string>
required
Available options:
scheduled,
queued,
running,
cancelled,
failed,
pending_retry,
complete
attempt
integer
required

Number of attempts made to run this sync. 0 means no attempts have been made.

batch_id
string<uuid> | null
required
completed_at
string<date-time> | null
required
entity_id
string | null
required
error
string | null
required

Error message if the sync failed.

file_id
string | null
required
is_initial_sync
boolean
required
is_one_off
boolean
required

Whether or not this is a one off sync

model_id
string
required
pagination_state
object | null
required
started_at
string<date-time> | null
required
timerange_end
string<date-time> | null
required

End of the time range for which data is being synced.

timerange_start
string<date-time> | null
required

Start of the time range for which data is being synced.

object
string
required
read-only

String representing the object's type. Objects of the same type share the same value.