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_records API

The subpackage_records API from Flatfile — 4 operation(s) for subpackage_records.

Flatfile subpackage_records 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 7 operations across 4 paths, and defines 40 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.

7 operations 4 paths 40 schemas 1 DELETE2 GET1 PATCH1 POST2 PUT

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_records API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 7

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

subpackage_records 7
GET
/sheets/{sheetId}/records
Get records
get 23 params → 200400404
PUT
/sheets/{sheetId}/records
Update records
update 3 params body → 200400404
POST
/sheets/{sheetId}/records
Insert records
insert 3 params body → 200400404
DELETE
/sheets/{sheetId}/records
Delete records
delete 4 params → 200400404
GET
/sheets/{sheetId}/records/indices
Get record Indices
indices 13 params → 200400404
PUT
/sheets/{sheetId}/find-replace
Finds and replaces field values matching search criteria
find-and-replace 9 params body → 200
PATCH
/sheets/{sheetId}/records/bulk-update
Bulk update records with field values
bulk-update 12 params body → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are type_records:Record (8 properties), type_records:CellValueWithLinks (7 properties), type_records:RecordWithLinks (6 properties), type_records:CellValue (6 properties). Each schema is shown below with its type and property counts.

type_commons:EventId
string
Event ID
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_records:CellConfig
object
CellConfig
1 property
type_commons:FilterField
string
Use this to narrow the valid/error filter results to a specific field
type_records:GetRecordsResponse
object
1 property 1 required
type_commons:CommitId
string
Commit ID
type_records:CellValueWithLinks
object
7 properties
type_records:RecordData
object
A single row of data in a Sheet
type_records:ValidationSource
string
type_records:ValidationType
string
type_commons:RecordId
string
Record ID
type_commons:SearchValue
string
Search for the given value, returning matching rows. For exact matches, wrap the value in double quotes ("Bob"). To search for null values, send empty double q…
type_commons:SheetId
string
Sheet ID
type_commons:Filter
string
Options to filter records
type_commons:Error
object
2 properties 1 required
type_records:RecordsWithLinks
array
List of Record objects, including links to related rows
type_records:GetRecordsResponseData
object
A list of records with optional record counts
5 properties 2 required
type_commons:SuccessData
object
1 property 1 required
type_records:RecordsResponse
object
1 property 1 required
type_records:RecordIndices
object
A record index object
2 properties 2 required
type_versions:Version
object
1 property 1 required
type_commons:SearchField
string
Use this to narrow the searchValue results to a specific field
type_records:RecordsResponseData
object
5 properties 1 required
type_commons:Errors
object
1 property 1 required
type_records:RecordWithLinks
object
A single row of data in a Sheet, including links to related rows
6 properties 2 required
type_commons:SortDirection
string
Sort direction - asc (ascending) or desc (descending)
type_records:Record
object
A single row of data in a Sheet
8 properties 2 required
type_commons:SortField
string
Name of field by which to sort records
type_records:RecordDataWithLinks
object
A single row of data in a Sheet, including links to related rows
type_versions:VersionResponse
object
1 property 1 required
type_records:FieldRecordCounts
object
4 properties 4 required
type_records:ValidationMessage
object
Record data validation messages
5 properties
type_records:RecordConfig
object
Configuration of a record or specific fields in the record
3 properties
type_commons:JSONPathString
string
A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535
type_records:GetRecordIndicesResponse
array
type_records:CellValueUnion
type_records:RecordCounts
object
5 properties 3 required
type_records:CellValue
object
6 properties
type_records:Records
array
List of Record objects
type_commons:VersionId
string
Version ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-records-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_records 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.