GET
/
api
/
syncs
/
{sync_id}
Get Sync Status
curl --request GET \
  --url https://sync.useparagon.com/api/syncs/{sync_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "active",
  "summary": {
    "total_records": 123,
    "synced_records_count": 123,
    "last_synced_at": "2023-11-07T05:31:56Z"
  }
}

You will receive fields for:

  • status — This tells you the status of your sync with Paragon’s persistent data store.
    • active
    • idle
      • Check summary.last_synced_at to see if the sync has successfully completed
    • paused
    • errored
  • summary — Metrics on the sync progress and last seen record timestamps.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sync_id
string
required

ID of the sync to get the status of

Response

200
application/json

Sync status

The response is of type object.