Snapshots

List snapshots

GET
List all snapshots of a sheet

Query parameters

sheetIdstringRequired
ID of sheet

Response

This endpoint returns an object
data
list of objects

Errors

GET
$curl -G https://api.x.flatfile.com/v1/snapshots \
> -H "Authorization: Bearer <token>" \
> -d sheetId=us_sh_YOUR_ID
Response
1{
2 "data": [
3 {
4 "id": "us_ss_YOUR_ID",
5 "sheetId": "us_sh_YOUR_ID",
6 "createdAt": "2023-01-01T00:00:00Z",
7 "createdBy": "us_usr_YOUR_ID",
8 "label": "My snapshot",
9 "summary": {
10 "createdSince": {
11 "total": 0
12 },
13 "updatedSince": {
14 "total": 5,
15 "byField": {
16 "lastName": 5
17 }
18 },
19 "deletedSince": {
20 "total": 5,
21 "byField": {
22 "firstName": 1
23 }
24 }
25 }
26 }
27 ]
28}