Flatfile subpackage_workbooks API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes
6 operations
across 3 paths,
and defines 64 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.x.flatfile.com/v1.
6 operations3 paths64 schemas1 DELETE3 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.x.flatfile.com/v1
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Flatfile subpackage_workbooks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (default).
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_workbooks 6
GET
/workbooks
List workbooks
list9 params→ 200400
POST
/workbooks
Create a workbook
create2 paramsbody→ 200400
GET
/workbooks/{workbookId}
Get a workbook
get3 params→ 200400404
DELETE
/workbooks/{workbookId}
Delete a workbook
delete3 params→ 200400404
PATCH
/workbooks/{workbookId}
Update a workbook
update3 paramsbody→ 200400404
GET
/workbooks/{workbookId}/commits
Get commits for a workbook
get-workbook-commits4 params→ 200
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are type_commons:Action (25 properties), type_workbooks:Workbook (19 properties), type_sheets:SheetConfigOrUpdate (18 properties), type_sheets:Sheet (16 properties). Each schema is shown below with its type and property counts.
type_workbooks:WorkbookUpdate
object
The updates to be made to an existing workbook
10 properties
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_sheets:SheetConfig
object
Describes shape of data as well as behavior
13 properties2 required
type_property:FieldAppearance
object
Control the appearance of this field when it's displayed in a table or input
1 property
type_commons:CommitId
string
Commit ID
type_property:EnumPropertyOption
object
8 properties1 required
type_commons:Guide
object
1 property1 required
type_property:FieldSize
string
The default visual sizing. This sizing may be overridden by a user
type_records:ValidationType
string
type_commons:InputConstraintType
string
type_workbooks:WorkbookConfigSettings
object
Settings for a workbook
4 properties
type_property:NumberConfig
object
1 property
type_property:RequiredConstraintConfig
object
2 properties
type_commons:ActionMode
string
Foreground actions will prevent interacting with the resource until complete
type_sheets:SheetConstraint
type_commons:ActionSchedule
string
type_commits:Commit
object
A commit version
6 properties4 required
type_commons:ActionMessageType
string
type_sheets:CompositeUniqueConstraintStrategy
string
type_commons:SheetId
string
Sheet ID
type_commons:ActionId
string
Action ID
type_property:ReferenceFilter
object
If provided, the reference filter will narrow the set of records in the reference sheet used as the set of valid values for the record. Only rows where the val…
2 properties2 required
type_property:StringConfigOptions
string
How much text should be storeable in this field
type_property:UniqueConstraintConfig
object
4 properties
type_sheets:SheetAccess
string
type_sheets:Sheet
object
A place to store tabular data
16 properties7 required
type_commons:InputConstraint
object
1 property1 required
type_commons:ActionMessage
object
2 properties2 required
type_commons:EnvironmentId
string
Environment ID
type_commons:InputForm
object
2 properties2 required
type_commons:Error
object
2 properties1 required
type_property:StringConfig
object
1 property1 required
type_commons:InputField
object
7 properties3 required
type_commons:SuccessData
object
1 property1 required
type_commons:ActionConstraint
type_commons:ActionMount
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property1 required
type_sheets:SheetConfigOrUpdate
object
18 properties
type_commons:InputEnumPropertyOption
object
6 properties1 required
type_workbooks:Workbook
object
A collection of one or more sheets
19 properties5 required
type_property:EnumPropertyConfig
object
3 properties1 required
type_commons:Errors
object
1 property1 required
type_commits:ListCommitsResponse
object
1 property1 required
type_property:BooleanPropertyConfig
object
1 property1 required
type_commons:Action
object
25 properties1 required
type_sheets:SheetTreatments
string
type_workbooks:CreateWorkbookConfig
object
Properties used to create a new Workbook
12 properties1 required
type_commons:SpaceId
string
Space ID
type_property:ReferencePropertyConfig
object
4 properties2 required
type_sheets:CompositeUniqueConstraintConfig
object
2 properties
type_property:ReferencePropertyRelationship
string
type_commons:Guardrail
object
1 property1 required
type_records:FieldRecordCounts
object
4 properties4 required
type_commons:WorkbookId
string
Workbook ID
type_workbooks:WorkbookResponse
object
1 property1 required
type_property:Constraint
type_workbooks:ListWorkbooksResponse
object
1 property1 required
type_property:Property
type_property:EnumPropertySortBy
string
type_records:RecordCounts
object
5 properties3 required
type_workbooks:WorkbookTreatments
string
Available treatments for a workbook
type_property:ReferenceListPropertyConfig
object
3 properties2 required
type_workbooks:StorageStrategy
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Flatfile subpackage_workbooks API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
