GET
/
records
cURL
curl --request GET \
  --url https://api.nango.dev/records \
  --header 'Connection-Id: <connection-id>' \
  --header 'Provider-Config-Key: <provider-config-key>'
{
  "records": [
    {
      "your-properties": "Your synced data, in the schema you (or Nango) defined in nango.yaml",
      "_nango_metadata": {
        "deleted_at": "<string>",
        "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=="
      }
    }
  ],
  "next_cursor": "MjAyMy0xMS0xN1QxMTo0NzoxNC40NDcrMDI6MDB8fDAzZTA1NzIxLWNiZmQtNGYxNS1iYTNhLWFlNjM2Y2MwNmEw=="
}

​
Receive webhooks on data updates

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

​
Response

This endpoint returns a list of records, ordered by modification date ascending. If some records are updated while you paginate through this endpoint, you might see these records multiple times.

​
Default behaviour

By default this returns an array of objects in the data model that you queried with some metadata about each record. 
{ 
    records: 
        [
            {
                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=='
                }
            },
            ...
        ],
    next_cursor: "MjAyMy0xMS0xN1QxMTo0NzoxNC40NDcrMDI6MDB8fDAzZTA1NzIxLWNiZmQtNGYxNS1iYTNhLWFlNjM2Y2MwNmEw=="
}

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

​
cursor
string

Each record from this method 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.

​
limit
integer

The maximum number of records to return. Defaults to 100.

​
filter
enum<string>

Filter to only show results that have been added or updated or deleted.

Available options:
added,
updated,
deleted
​
modified_after
string

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

​
delta (deprecated)
string

DEPRECATED (use modified_after) Timestamp, e.g. 2023-05-31T11:46:13.390Z. If passed, only records modified after this timestamp are returned, otherwise all records are returned.

Response

Successfully returned records

The response is of type object.