Skip to main content
POST
/
v2
/
integrations
/
connections
/
{connection_id}
/
sync
Request a Sync
curl --request POST \
  --url https://api.example.com/v2/integrations/connections/{connection_id}/sync \
  --header 'Authorization: Bearer <token>'
[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "status": "scheduled",
    "attempt": 123,
    "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "completed_at": "2023-11-07T05:31:56Z",
    "entity_id": "<string>",
    "error": "<string>",
    "file_id": "<string>",
    "is_initial_sync": true,
    "is_one_off": true,
    "model_id": "<string>",
    "pagination_state": {},
    "started_at": "2023-11-07T05:31:56Z",
    "timerange_end": "2023-11-07T05:31:56Z",
    "timerange_start": "2023-11-07T05:31:56Z",
    "object": "<string>"
  }
]

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

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