Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
Files
Guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
GET
List workbooks
POST
Create a workbook
GET
Get a workbook
DEL
Delete a workbook
PATCH
Update a workbook
GET
Get commits for a workbook
Community
Create Account
Sign in
API Reference
Workbooks
List workbooks
GET
https://api.x.flatfile.com/v1
/
workbooks
Returns all workbooks matching a filter for an account or space
Query parameters
spaceId
string
Optional
The associated Space ID of the Workbook.
name
string
Optional
Filter by name. Precede with - to negate the filter
namespace
string
Optional
Filter by namespace. Precede with - to negate the filter
label
string
Optional
Filter by label. Precede with - to negate the filter
treatment
string
Optional
Filter by treatment.
includeSheets
boolean
Optional
Include sheets for the workbook (default true)
includeCounts
boolean
Optional
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
Show 14 properties
Errors
400
Bad Request
Built with