List sheets

GET

Returns sheets in a workbook

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Query parameters

workbookIdstringRequired

ID of workbook

Response

This endpoint returns an object.

datalist of objects

GET

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

200Retrieved

1 {
2   "data": [
3     {
4       "id": "us_sh_YOUR_ID",
5       "workbookId": "us_wb_YOUR_ID",
6       "name": "Contacts",
7       "slug": "contacts",
8       "config": {
9         "name": "Contacts",
10         "fields": [
11           {
12             "type": "string",
13             "key": "firstName",
14             "label": "First Name"
15           },
16           {
17             "type": "string",
18             "key": "lastName",
19             "label": "Last Name"
20           },
21           {
22             "type": "string",
23             "key": "email",
24             "label": "Email"
25           }
26         ],
27         "slug": "contacts",
28         "mappingConfidenceThreshold": 0.5
29       },
30       "updatedAt": "2021-08-31T18:00:00Z",
31       "createdAt": "2021-08-31T18:00:00Z",
32       "metadata": {
33         "rowHeaders": [
34           4
35         ]
36       }
37     }
38   ]
39 }

Built with

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

1	{
2	"data": [
3	{
4	"id": "us_sh_YOUR_ID",
5	"workbookId": "us_wb_YOUR_ID",
6	"name": "Contacts",
7	"slug": "contacts",
8	"config": {
9	"name": "Contacts",
10	"fields": [
11	{
12	"type": "string",
13	"key": "firstName",
14	"label": "First Name"
15	},
16	{
17	"type": "string",
18	"key": "lastName",
19	"label": "Last Name"
20	},
21	{
22	"type": "string",
23	"key": "email",
24	"label": "Email"
25	}
26	],
27	"slug": "contacts",
28	"mappingConfidenceThreshold": 0.5
29	},
30	"updatedAt": "2021-08-31T18:00:00Z",
31	"createdAt": "2021-08-31T18:00:00Z",
32	"metadata": {
33	"rowHeaders": [
34	4
35	]
36	}
37	}
38	]
39	}