Workbooks

List workbooks

GET

Returns all workbooks matching a filter for an account or space

Query parameters

spaceIdstringOptional

The associated Space ID of the Workbook.

namestringOptional

Filter by name. Precede with - to negate the filter

namespacestringOptional

Filter by namespace. Precede with - to negate the filter

labelstringOptional

Filter by label. Precede with - to negate the filter

treatmentstringOptional

Filter by treatment.

includeSheetsbooleanOptional

Include sheets for the workbook (default true)

includeCountsbooleanOptional

Include counts for the workbook. DEPRECATED Counts will return 0s. Use GET /sheets/:sheetId/counts

Response

This endpoint returns an object

data

list of objects

A collection of one or more sheets

Errors

GET

1 curl -G https://api.x.flatfile.com/v1/workbooks \
2      -H "Authorization: Bearer <token>" \
3      -d spaceId=us_sp_YOUR_ID

1 {
2   "data": [
3     {
4       "id": "us_wb_YOUR_ID",
5       "spaceId": "us_sp_YOUR_ID",
6       "environmentId": "us_env_YOUR_ID",
7       "updatedAt": "2021-01-01T00:00:00Z",
8       "createdAt": "2021-01-01T00:00:00Z",
9       "name": "My First Workbook",
10       "sheets": [
11         {
12           "id": "us_sh_YOUR_ID",
13           "workbookId": "us_wb_YOUR_ID",
14           "name": "Contacts",
15           "slug": "contacts",
16           "config": {
17             "name": "Contacts",
18             "fields": [
19               {
20                 "type": "string",
21                 "key": "firstName",
22                 "label": "First Name"
23               },
24               {
25                 "type": "string",
26                 "key": "lastName",
27                 "label": "Last Name"
28               },
29               {
30                 "type": "string",
31                 "key": "email",
32                 "label": "Email"
33               }
34             ],
35             "slug": "contacts",
36             "mappingConfidenceThreshold": 0.5
37           },
38           "updatedAt": "2021-08-31T18:00:00Z",
39           "createdAt": "2021-08-31T18:00:00Z",
40           "metadata": {
41             "rowHeaders": [
42               4
43             ]
44           }
45         }
46       ],
47       "labels": [
48         "simple-demo"
49       ],
50       "actions": [
51         {
52           "label": "Submit",
53           "operation": "submitAction",
54           "mode": "foreground",
55           "description": "Submit data to webhook.site",
56           "primary": true
57         }
58       ],
59       "settings": {
60         "trackChanges": true
61       },
62       "expiredAt": "2021-01-01T00:00:00Z"
63     }
64   ]
65 }

Built with

1	curl -G https://api.x.flatfile.com/v1/workbooks \
2	-H "Authorization: Bearer <token>" \
3	-d spaceId=us_sp_YOUR_ID

1	{
2	"data": [
3	{
4	"id": "us_wb_YOUR_ID",
5	"spaceId": "us_sp_YOUR_ID",
6	"environmentId": "us_env_YOUR_ID",
7	"updatedAt": "2021-01-01T00:00:00Z",
8	"createdAt": "2021-01-01T00:00:00Z",
9	"name": "My First Workbook",
10	"sheets": [
11	{
12	"id": "us_sh_YOUR_ID",
13	"workbookId": "us_wb_YOUR_ID",
14	"name": "Contacts",
15	"slug": "contacts",
16	"config": {
17	"name": "Contacts",
18	"fields": [
19	{
20	"type": "string",
21	"key": "firstName",
22	"label": "First Name"
23	},
24	{
25	"type": "string",
26	"key": "lastName",
27	"label": "Last Name"
28	},
29	{
30	"type": "string",
31	"key": "email",
32	"label": "Email"
33	}
34	],
35	"slug": "contacts",
36	"mappingConfidenceThreshold": 0.5
37	},
38	"updatedAt": "2021-08-31T18:00:00Z",
39	"createdAt": "2021-08-31T18:00:00Z",
40	"metadata": {
41	"rowHeaders": [
42	4
43	]
44	}
45	}
46	],
47	"labels": [
48	"simple-demo"
49	],
50	"actions": [
51	{
52	"label": "Submit",
53	"operation": "submitAction",
54	"mode": "foreground",
55	"description": "Submit data to webhook.site",
56	"primary": true
57	}
58	],
59	"settings": {
60	"trackChanges": true
61	},
62	"expiredAt": "2021-01-01T00:00:00Z"
63	}
64	]
65	}