Skip to main content
GET
Pull Synced Records
Each page that you consume when pulling synced records returns a stable cursor for the last record of that page in paging.cursor. When you receive data as an empty array or paging.remainingRecords = 0, your application is caught up to the latest data synced to Paragon. You can persist the last available paging.cursor value and resume from it later — for example, when you receive record_created or record_updated webhooks, or when polling for new changes using a recurring job.
Records from this endpoint are ordered as a change log of creates, updates, and deletes, based on when Paragon last synced each record.You can always pass a cursor value that you received from the API as paging.cursor to catch up on all creates, updates, and deletes that Paragon observed since that page.What if data changes while I am ingesting records from the Initial Sync?If records are created or updated while you are still paging through a large Sync (for example during an initial pull of many files), those changes can appear on later pages of the same pull loop. That includes updates to records you already consumed earlier in the loop, so you can pick up the latest content even when source data changes mid-pull.Can I use a pagination cursor after full or incremental syncs run?Yes, any cursor provided by the API remains valid for resuming from that point at any time later, including after a periodic full sync has run.The latestCursor returned from the API can change after a full or incremental sync because new or updated records may be available to pull when a sync detects changes. However, you can still pass your saved cursor to continue from where you left off.

Authorizations

Authorization
string
header
required

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

Path Parameters

syncId
string
required

ID of the sync

Query Parameters

pageSize
integer

Number of records to return per page

cursor
string

Pagination cursor returned in paging.cursor from a previous response. Pass it to resume from that point in the change log of synced records.

Response

Synced records

data
object[]
required

Array of synced records. See schemas in Synced Objects for the available fields.

Example:

"[/* See schema in Synced Objects */]"

paging
object
required