GET
/
records
curl --request GET \
  --url https://api.nango.dev/records \
  --header 'Authorization: Bearer <token>' \
  --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": "2023-11-07T05:31:56Z",
        "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=="
}

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

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

A marker used to fetch records modified after a specific point in time. If not provided, all records are returned. Each record includes a cursor value found in _nango_metadata.cursor. Save the cursor from the last record retrieved to track your sync progress. Use the cursor parameter together with the limit parameter to paginate through records. The cursor is more precise than modified_after, as it can differentiate between records with the same modification timestamp.

​
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

A timestamp (e.g., 2023-05-31T11:46:13.390Z) used to fetch records modified after this date and time. If not provided, all records are returned. The modified_after parameter is less precise than cursor, as multiple records may share the same modification timestamp.

​
delta
string
deprecated

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.

​
ids
string[]

An array of string containing a list of your records IDs. The list will be filtered to include only the records with a matching ID.

​
variant
string

The variant of the model to fetch

Response

200
application/json

Successfully returned records

The response is of type object.