Skip to main content
GET
Get Sync Job Status

Authorizations

Authorization
string
header
required

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

Headers

X-Application-Id
string

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Token
string
required

The token returned when a user authenticated their account. This authorizes access to a specific account.

Pattern: ^con_tkn_\S+$
Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Path Parameters

id
string<ulid>
required
Pattern: ^sync_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

Query Parameters

expand
enum<string>

Expand related resources in the response to reduce requests.

Available options:
issues

Response

OK

id
string<ulid>
required
Pattern: ^sync_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"sync_01GV12VR4DJP70GD1ZBK0SDWFH"

status
enum<string>
required

The status of the sync

Available options:
requested,
in_progress,
completed,
failed
Example:

"completed"

requestedAt
string<date-time>
required
Example:

"2021-01-06T03:24:53.000Z"

failureReason
string

If the sync failed, this will contain the reason

Example:

"Reason for failure if sync status is 'failed'"

progress
number

Current sync progress as a percentage between 0 and 100.

Required range: 0 <= x <= 100
Example:

85

issues
(string<ulid> | Issue · object)[]

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.

Pattern: ^isu_[0-9A-HJKMNP-TV-Z]{26}$
Example:

"isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"

startFrom
string<date-time>

The earliest records to sync for those based on time (ex: historical locations and stats)

Example:

"2021-01-06T03:24:53.000Z"

completedAt
string<date-time>
Example:

"2021-01-06T03:24:53.000Z"

attempts
number
Example:

1

providerRequests
enum<string>[]

Provider requests attached to this sync. When non-empty, the sync is waiting on an out-of-band step on the provider's side (e.g. the provider manually delivering historical files, or credentials being provisioned) and may legitimately stay in progress for an extended period.

Available options:
historical_files,
provision_credentials
Example: