Skip to main content
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"
      }
    }
  ],
  "next_cursor": "MjAyMy0xMS0xN1QxMTo0NzoxNC40NDcrMDI6MDB8fDAzZTA1NzIxLWNiZmQtNGYxNS1iYTNhLWFlNjM2Y2MwNmEw=="
}

​
The delta parameter & webhooks

If you are using the Nango webhooks you can use the timestamp you get from the webhook for the delta parameter.

​
Response

​
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'
                }
            },
            ...
        ],
    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

​
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.

​
cursor
string

Base 64 encoded value that can be used to fetch the next page of results. The cursor will be included until there are no more results to paginate through.

​
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

Successfully returned records

​
records
object[]
​
next_cursor
string

The base64-encoded cursor for pagination

Example:

"MjAyMy0xMS0xN1QxMTo0NzoxNC40NDcrMDI6MDB8fDAzZTA1NzIxLWNiZmQtNGYxNS1iYTNhLWFlNjM2Y2MwNmEw=="

⌘I