Snapshots

Get records from a snapshot

GET
Gets records from a snapshot of a sheet

Path parameters

snapshotIdstringRequired
ID of snapshot

Query parameters

pageSizeintegerOptional
Number of records to return in a page
pageNumberintegerOptional
Based on pageSize, which page of records to return
changeTypeenumOptional
Filter records by change type

Response

This endpoint returns an object
data
list of objects
List of DiffRecord objects

Errors

GET
$curl -G https://api.x.flatfile.com/v1/snapshots/us_ss_YOUR_ID/records \
> -H "Authorization: Bearer <token>" \
> -d pageSize=10 \
> -d pageNumber=1 \
> -d changeType=createdSince
Response
1{
2 "data": [
3 {
4 "id": "us_rc_YOUR_ID",
5 "values": {
6 "firstName": {
7 "snapshotValue": "John",
8 "value": "Johns"
9 },
10 "lastName": {
11 "snapshotValue": "Doe",
12 "value": "Does"
13 },
14 "email": {
15 "snapshotValue": "john.doe@example.com",
16 "value": "john.doe@example.com"
17 }
18 }
19 }
20 ]
21}