Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Data Management

List Sync History

List a log of all batch sync jobs for the current connection.

get/syncs

Query parameters

limitinteger

The maximum number of results to return in a page.

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

status'requested' | 'in_progress' | 'completed' | 'failed'

The status of the sync

Example:completed
expand'issues'

Expand related resources in the response to reduce requests.

Headers

X-Application-Idstring

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-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

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

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "sync_01GV12VR4DJP70GD1ZBK0SDWFH",
      "status": "completed",
      "failureReason": "Reason for failure if sync status is 'failed'",
      "progress": 85,
      "issues": [
        "isu_01D8ZQFGHVJ858NBF2Q7DV9MNC"
      ],
      "startFrom": "2021-01-06T03:24:53.000Z",
      "requestedAt": "2021-01-06T03:24:53.000Z",
      "completedAt": "2021-01-06T03:24:53.000Z",
      "attempts": 1,
      "providerRequests": [
        "historical_files"
      ]
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}