Snapshots

Create a snapshot

POST
Creates a snapshot of a sheet

Request

This endpoint expects an object.
sheetId
stringRequired
ID of sheet
label
stringOptional
Label for the snapshot

Response

This endpoint returns an object
data
object

Errors

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