GET
/
api
/
syncs
/
{sync_id}
/
records
Pull Synced Records
curl --request GET \
  --url https://sync.useparagon.com/api/syncs/{sync_id}/records \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {}
  ],
  "paging": {
    "total_records": 123,
    "remaining_records": 123,
    "cursor": "<string>",
    "last_seen": "2023-11-07T05:31:56Z"
  }
}

Each page that you consume in pulling syncing records will return a stable cursor representing the last record of the page in paging.cursor.

When you receive data as an empty array or paging.remaining_records = 0, your application is caught up to the latest data synced to Paragon.

You can persist the last available paging.cursor value to sync available pages when you receive record_created webhooks in the future.

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

Query Parameters

​
page_size
integer

Number of records to return per page

​
cursor
string

Cursor for pagination

Response

200
application/json

Synced records

The response is of type object.