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.
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
$curl -G https://api.x.flatfile.com/v1/workbooks \
> -H "Authorization: Bearer <token>" \
> -d spaceId=us_sp_YOUR_ID
Response
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 "lockedBy": "Example0"
41 }
42 ],
43 "labels": [
44 "simple-demo"
45 ],
46 "actions": [
47 {
48 "label": "Submit",
49 "operation": "submitAction",
50 "mode": "foreground",
51 "description": "Submit data to webhook.site",
52 "primary": true
53 }
54 ],
55 "settings": {
56 "trackChanges": true
57 },
58 "expiredAt": "2021-01-01T00:00:00Z"
59 }
60 ]
61}