Data Management
Get Sync Job Status
Get the status of a sync job by ID.
GET
/
syncs
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Connection-Token
string
requiredThe token returned when a user authenticated their account. This authorizes access to a specific account.
Path Parameters
id
string
requiredQuery Parameters
expand
enum<string>
Expand related resources in the response to reduce requests.
Available options:
issues
Response
200 - application/json
id
string
requiredstatus
enum<string>
requiredAvailable options:
requested
, in_progress
, completed
, failed
failureReason
string
If the sync failed, this will contain the reason
issues
array
Issues are problems encountered with a connection that did not result in a failed sync but may require manual intervention. You can see the issues for a given sync by providing issues
to the expand
parameter.
startFrom
string
The earliest records to sync for those based on time (ex: historical locations and stats)
requestedAt
string
requiredISO 8601 date
completedAt
string
ISO 8601 date