GET
/
sync
/
records

​
Receive webhooks on data updates

Receive webhooks from Nango when new records are available (step-by-step guide).

​
Keeping track of where you left off

Each record from this endpoint comes with a synchronization cursor in _nango_metadata.cursor.

Save the last fetched record’s cursor to track how far you’ve synced.

By providing the cursor to this endpoint, you’ll continue syncing from where you left off, receiving only post-cursor changes.

This same cursor is used to paginate through the results of this endpoint.

​
Response

By default, this returns an array of records in the data model that you queried, with some metadata about each record.

[
    {
        id: 123,
        ..., // Fields as specified in the model you queried
        _nango_metadata: {
            deleted_at: null,
            last_action: 'ADDED',
            first_seen_at: '2023-09-18T15:20:35.941305+00:00',
            last_modified_at: '2023-09-18T15:20:35.941305+00:00',
            cursor: 'MjAyNC0wMy0wNFQwNjo1OTo1MS40NzE0NDEtMDU6MDB8fDE1Y2NjODA1LTY0ZDUtNDk0MC1hN2UwLTQ1ZmM3MDQ5OTdhMQ=='
        }
    },
    ...
]

Headers

Connection-Id
string
required

The connection ID used to create the connection.

Provider-Config-Key
string
required

The integration ID used to create the connection (aka Unique Key).

Query Parameters

model
string
required

The data model to fetch

delta
string

Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed only records added or updated after this timestamp are returned, otherwise all records are returned.

limit
integer

The maximum number of records to return. If not passed, all records are returned.

offset
integer

The number of records to skip. If not passed, no records are skipped.

sort_by
enum<string>

Set how the records are sorted. The default is id. The options are 'created_at', 'updated_at', 'id'.

Available options:
created_at,
updated_at,
id
order
enum<string>

Set the order of results. The default is 'desc'. The options are 'desc' or 'asc'.

Available options:
desc,
asc
filter
enum<string>

Filter to only show results that have been added or updated or deleted. Helpful when used in conjuction with the delta parameter to retrieve a subset or records that were added, updated, or deleted with the latest sync.

Available options:
added,
updated,
deleted

Response

200 - application/json
your-properties
string

The data Nango synced in for you

_nango_metadata
object

Was this page helpful?

Get recordsTrigger sync(s)