List Syncs

List Syncs

curl --request GET \
  --url https://sync.useparagon.com/api/syncs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "integration": "<string>",
      "pipeline": "<string>",
      "status": "INITIALIZING",
      "configurationName": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

api

syncs

List Syncs

curl --request GET \
  --url https://sync.useparagon.com/api/syncs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "integration": "<string>",
      "pipeline": "<string>",
      "status": "INITIALIZING",
      "configurationName": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Paragon User Token. Add to the Authorization header of your requests.

Response

200 - application/json

List of Syncs

data

object[]

Show child attributes

data.id

string

Unique identifier for the Sync

data.integration

string

The integration this Sync uses

data.pipeline

string

The type of Synced Object being synced

data.status

enum<string>

Current state of Sync activity. Possible values:

INITIALIZING: The Sync has just been created and is pending its first run.
ACTIVE: The Sync is actively fetching new data.
IDLE: The Sync has completed and is watching for updates to synced data.
- Check summary.lastSyncedAt to see if the sync has successfully completed.
DISABLED: The Sync has been paused temporarily by the Disable a Sync endpoint.
ERRORED: The Sync has been suspended due to an error. Check Webhook Events for additional error details.

Available options:

INITIALIZING,

ACTIVE,

IDLE,

DISABLED,

ERRORED

data.configurationName

string

The name of the Sync configuration as provided when the Sync was created

data.dateCreated

string<date-time>

The date and time the Sync was created

data.dateUpdated

string<date-time>

The date and time the Sync was last updated

Download File Content Disable a Sync

⌘I

Managed Sync

Sync API

Permissions API

Integrations Reference

Authorizations

Response