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

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

Flatfile subpackage_mapping 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 13 operations across 4 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.

13 operations 4 paths 64 schemas 4 DELETE4 GET3 PATCH2 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_mapping API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 13

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

subpackage_mapping 13
POST
/mapping
Create a mapping between two schemas
create-mapping-program 3 params body → 200400404
DELETE
/mapping
Delete all history for the authenticated user
delete-all-history-for-user 2 params body → 200400404
GET
/mapping
List mapping programs
list-mapping-programs 13 params → 200400
GET
/mapping/{programId}
Get a mapping program
get-mapping-program 3 params → 200400404
PATCH
/mapping/{programId}
Update a mapping program
update-mapping-program 3 params body → 200400404
DELETE
/mapping/{programId}
Delete a mapping program
delete-mapping-program 3 params → 200400404
POST
/mapping/{programId}/rules
Add mapping rules to a program
create-rules 3 params body → 200400404
DELETE
/mapping/{programId}/rules
Delete multiple mapping rules
delete-multiple-rules 3 params body → 200400404
GET
/mapping/{programId}/rules
List mapping rules
list-rules 3 params → 200400404
PATCH
/mapping/{programId}/rules
Update a list of mapping rules
update-rules 3 params body → 200400404
GET
/mapping/{programId}/rules/{mappingId}
Get a mapping rule
get-rule 4 params → 200400404
PATCH
/mapping/{programId}/rules/{mappingId}
Update a mapping rule
update-rule 4 params body → 200400404
DELETE
/mapping/{programId}/rules/{mappingId}
Delete a mapping rule
delete-rule 4 params → 200400404

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_sheets:SheetConfig (13 properties), type_mapping:Program (12 properties), type_mapping:MappingRule (12 properties). Each schema is shown below with its type and property counts.

type_commons:ActorId
string
Actor ID
type_commons:Success
object
Informs whether or not a request was successful
1 property
type_mapping:ProgramResponse
object
1 property 1 required
type_sheets:SheetConfig
object
Describes shape of data as well as behavior
13 properties 2 required
type_mapping:ProgramSummary
object
3 properties 3 required
type_property:FieldAppearance
object
Control the appearance of this field when it's displayed in a table or input
1 property
type_property:EnumPropertyOption
object
8 properties 1 required
type_commons:Guide
object
1 property 1 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_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_mapping:ProgramsResponse
object
1 property 1 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:InputConstraint
object
1 property 1 required
type_commons:ActionMessage
object
2 properties 2 required
type_commons:EnvironmentId
string
Environment ID
type_commons:InputForm
object
2 properties 2 required
type_commons:Error
object
2 properties 1 required
type_property:StringConfig
object
1 property 1 required
type_commons:InputField
object
7 properties 3 required
type_mapping:MappingRule
object
12 properties 5 required
type_commons:SuccessData
object
1 property 1 required
type_commons:ActionConstraint
type_commons:ActionMount
type_mapping:MappingRuleConfig
object
6 properties 2 required
type_commons:InputFormType
string
type_commons:InputConfig
object
1 property 1 required
type_commons:JobId
string
Pipeline Job ID
type_mapping:Program
object
12 properties 3 required
type_mapping:ProgramConfig
object
6 properties 2 required
type_commons:InputEnumPropertyOption
object
6 properties 1 required
type_property:EnumPropertyConfig
object
3 properties 1 required
type_commons:Errors
object
1 property 1 required
type_property:BooleanPropertyConfig
object
1 property 1 required
type_sheets:SheetTreatments
string
type_commons:Action
object
25 properties 1 required
type_commons:FamilyId
string
Mapping Family ID
type_mapping:MappingRuleOrConfig
object
12 properties 2 required
type_property:ReferencePropertyConfig
object
4 properties 2 required
type_sheets:CompositeUniqueConstraintConfig
object
2 properties
type_property:ReferencePropertyRelationship
string
type_mapping:CreateMappingRulesRequest
array
type_mapping:MappingRuleResponse
object
1 property 1 required
type_commons:Guardrail
object
1 property 1 required
type_commons:UserId
string
User ID
type_mapping:UpdateMappingRulesRequest
array
type_mapping:MappingRulesResponse
object
1 property 1 required
type_property:Constraint
type_property:Property
type_property:EnumPropertySortBy
string
type_commons:MappingId
string
Mapping Rule ID
type_property:ReferenceListPropertyConfig
object
3 properties 2 required
type_commons:ProgramId
string
Mapping Program ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-mapping-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_mapping 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.