List snapshots

GET

1 curl -G https://api.x.flatfile.com/v1/snapshots \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -d sheetId=us_sh_YOUR_ID

Play

200Example0

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         "schemaDiff": {
26           "firstName": "added",
27           "lastName": "removed",
28           "email": "unchanged"
29         },
30         "config": {
31           "name": "Contacts",
32           "fields": [
33             {
34               "type": "string",
35               "key": "firstName",
36               "label": "First Name"
37             },
38             {
39               "type": "string",
40               "key": "lastName",
41               "label": "Last Name"
42             },
43             {
44               "type": "string",
45               "key": "email",
46               "label": "Email"
47             }
48           ],
49           "slug": "contacts",
50           "mappingConfidenceThreshold": 0.5
51         }
52       }
53     }
54   ]
55 }

List all snapshots of a sheet

Query parameters

sheetIdstringRequired

ID of sheet

threadIdstringOptional

ID of thread to filter snapshots by

Response

This endpoint returns an object.

datalist of objects

List snapshots

Headers

Query parameters

Response

Errors