Workbooks

Get a workbook

GET

Returns a single workbook

Path parameters

workbookIdstringRequired

ID of workbook to return

Response

This endpoint returns an object

data

object

A collection of one or more sheets

Errors

GET

1 curl https://api.x.flatfile.com/v1/workbooks/us_wb_YOUR_ID \
2      -H "Authorization: Bearer <token>"

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

Built with

1	curl https://api.x.flatfile.com/v1/workbooks/us_wb_YOUR_ID \
2	-H "Authorization: Bearer <token>"

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