GET
/
syncs
curl --request GET \
  --url https://api.withterminal.com/tsp/v1/syncs \
  --header 'Authorization: Bearer <token>' \
  --header 'Connection-Token: <connection-token>'
{
  "results": [
    {
      "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
      "status": "completed",
      "failureReason": "Reason for failure if sync status is 'failed'",
      "issues": [
        "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "startFrom": "2021-01-06T03:24:53.000Z",
      "requestedAt": "2021-01-06T03:24:53.000Z",
      "completedAt": "2021-01-06T03:24:53.000Z"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Connection-Token
string
required

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

Example:

"con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4"

Query Parameters

​
limit
integer

The maximum number of results to return in a page.

​
cursor
string

Pagination cursor to start requests from

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
status
enum<string>

The status of the sync

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

"completed"

​
expand
enum<string>

Expand related resources in the response to reduce requests.

Available options:
issues

Response

200
application/json
OK
​
results
object[]
required

An object containing the state of a sync job. This can be polled after connection linking to know when data is available for ingestion.

​
next
string

Cursor used for pagination.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

Request SyncGet Sync Job Status