How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flatfile subpackage_runbooks API

The subpackage_runbooks API from Flatfile — 2 operation(s) for subpackage_runbooks.

Flatfile subpackage_runbooks 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 5 operations across 2 paths, and defines 18 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.

5 operations 2 paths 18 schemas 1 DELETE2 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_runbooks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_runbooks 5
GET
/runbooks
List runbooks
list 5 params → 200400404
POST
/runbooks
Create a runbook
create 2 params body → 200400404
GET
/runbooks/{runbookId}
Get a runbook
get 3 params → 200
PATCH
/runbooks/{runbookId}
Update a runbook
update 3 params body → 200400404
DELETE
/runbooks/{runbookId}
Delete a runbook
delete 3 params → 200400404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are type_runbooks:Runbook (12 properties), type_runbooks:CreateRunbookRequest (8 properties), type_runbooks:UpdateRunbookRequest (3 properties), type_runbooks:SheetTransformConfig (2 properties). Each schema is shown below with its type and property counts.

type_runbooks:Runbook
object
Runbook
12 properties 12 required
type_runbooks:SheetTransformConfig
object
2 properties 2 required
type_runbooks:RunbookStatus
string
type_commons:Error
object
2 properties 1 required
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_commons:RunbookId
string
Runbook ID
type_commons:SuccessData
object
1 property 1 required
type_runbooks:RunbookConfig
type_runbooks:RunbookType
string
type_commons:AccountId
string
Account ID
type_runbooks:UpdateRunbookRequest
object
3 properties
type_runbooks:RunbookResponse
object
1 property 1 required
type_commons:Errors
object
1 property 1 required
type_runbooks:CreateRunbookRequest
object
8 properties 8 required
type_commons:EnvironmentId
string
Environment ID
type_commons:AppId
string
App ID
type_runbooks:RunbooksResponse
object
1 property 1 required
type_commons:SpaceId
string
Space ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-runbooks-api-openapi.yml Raw ↑

Other APIs Flatfile publishes across the network.

Flatfile subpackage_accounts API
Flatfile subpackage_actions API
Flatfile subpackage_agent-exports API
Flatfile subpackage_agents API
Flatfile subpackage_apps API
Flatfile subpackage_assistant API
Flatfile subpackage_auth API
Flatfile subpackage_canvas-areas API
Flatfile subpackage_commits API
Flatfile subpackage_data-clips API
Flatfile subpackage_data-retention-policies API
Flatfile subpackage_documents API
Where this information came from

This is an independent, third-party profile of Flatfile subpackage_runbooks 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.