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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Flatfile

Flatfile subpackage_snapshots API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Flatfile subpackage_snapshots 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 4 paths, and defines 76 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 operations 4 paths 76 schemas 1 DELETE3 GET2 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_snapshots API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 6

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

subpackage_snapshots 6
POST
/snapshots
Create a snapshot
create-snapshot 2 params body → 200400404
GET
/snapshots
List snapshots
list-snapshots 4 params → 200400404
GET
/snapshots/{snapshotId}
Get a snapshot
get-snapshot 4 params → 200400404
DELETE
/snapshots/{snapshotId}
Delete a snapshot
delete-snapshot 3 params → 200400404
POST
/snapshots/{snapshotId}/restore
Restore a snapshot
restore-snapshot 3 params body → 200400404
GET
/snapshots/{snapshotId}/records
Get records from a snapshot
get-snapshot-records 6 params → 200400404

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are type_commons:Action (25 properties), type_sheets:SheetConfig (13 properties), type_records:DiffValue (10 properties), type_records:DiffRecord (9 properties). Each schema is shown below with its type and property counts.

type_snapshots:SchemaDiffRecord
type_snapshots:SchemaDiffData
object
type_snapshots:SchemaDiffEnum
string
type_records:CellConfig
object
CellConfig
1 property
type_sheets:SheetConfig
object
Describes shape of data as well as behavior
13 properties 2 required
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_commons:VersionId
string
Version ID
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 properties 1 required
type_commons:Guide
object
1 property 1 required
type_sheets:SheetConstraint
type_records:ValidationSource
string
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_data-clips:RemovedFromMainResolution
string
type_data-clips:Resolve
object
Conflict resolutions for a record
6 properties
type_property:ReferenceListPropertyConfig
object
3 properties 2 required
type_property:NumberConfig
object
1 property
type_property:RequiredConstraintConfig
object
2 properties
type_commons:RecordId
string
Record ID
type_commons:ActionMode
string
Foreground actions will prevent interacting with the resource until complete
type_commons:ActionSchedule
string
type_snapshots:SnapshotSummary
object
5 properties 5 required
type_commons:ActionMessageType
string
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 properties 2 required
type_sheets:SheetAccess
string
type_commons:ActionId
string
Action ID
type_property:StringConfigOptions
string
How much text should be storeable in this field
type_property:UniqueConstraintConfig
object
4 properties
type_sheets:CompositeUniqueConstraintStrategy
string
type_commons:SheetId
string
Sheet ID
type_data-clips:ResolveType
string
type_records:DiffData
object
type_records:DiffValue
object
10 properties
type_commons:InputConstraint
object
1 property 1 required
type_commons:ActionMessage
object
2 properties 2 required
type_commons:Error
object
2 properties 1 required
type_commons:InputForm
object
2 properties 2 required
type_property:StringConfig
object
1 property 1 required
type_commons:InputField
object
7 properties 3 required
type_commons:SuccessData
object
1 property 1 required
type_commons:ActionConstraint
type_commons:ActionMount
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property 1 required
type_commons:InputEnumPropertyOption
object
6 properties 1 required
type_snapshots:RestoreOptions
object
3 properties 3 required
type_property:EnumPropertyConfig
object
3 properties 1 required
type_commons:Errors
object
1 property 1 required
type_snapshots:ChangeType
string
Options to filter records in a snapshot
type_property:BooleanPropertyConfig
object
1 property 1 required
type_sheets:SheetTreatments
string
type_commons:Action
object
25 properties 1 required
type_property:ReferencePropertyConfig
object
4 properties 2 required
type_snapshots:Snapshot
object
7 properties 4 required
type_records:DiffRecords
array
List of DiffRecord objects
type_property:ReferencePropertyRelationship
string
type_sheets:CompositeUniqueConstraintConfig
object
2 properties
type_commons:Guardrail
object
1 property 1 required
type_snapshots:SnapshotResponse
object
1 property 1 required
type_records:ValidationMessage
object
Record data validation messages
5 properties
type_records:DiffRecord
object
9 properties 2 required
type_commons:UserId
string
User ID
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_property:Constraint
type_snapshots:SummarySection
object
2 properties 1 required
type_property:Property
type_property:EnumPropertySortBy
string
type_snapshots:SnapshotsResponse
object
1 property 1 required
type_records:CellValueUnion
type_data-clips:ResolveTo
string
type_commons:SnapshotId
string
Snapshot ID
type_records:DiffRecordsResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Flatfile publishes across the network.

Flatfile subpackage_accounts API
AE Profile APIs.io
Flatfile subpackage_actions API
AE Profile APIs.io
Flatfile subpackage_agent-exports API
AE Profile APIs.io
Flatfile subpackage_agents API
AE Profile APIs.io
Flatfile subpackage_apps API
AE Profile APIs.io
Flatfile subpackage_assistant API
AE Profile APIs.io
Flatfile subpackage_auth API
AE Profile APIs.io
Flatfile subpackage_canvas-areas API
AE Profile APIs.io
Flatfile subpackage_commits API
AE Profile APIs.io
Flatfile subpackage_data-clips API
AE Profile APIs.io
Flatfile subpackage_data-retention-policies API
AE Profile APIs.io
Flatfile subpackage_documents API
AE Profile APIs.io
← Back to F APIs
API Details
ID
flatfile:flatfile-subpackage-snapshots-api
Base URL
https://api.x.flatfile.com/v1
Docs
https://reference.flatfile.com/
Provider
Flatfile
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=flatfile-subpackage-snapshots-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/flatfile-subpackage-snapshots-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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_snapshots 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.