API Reference

flatfile.com

Changelog

Guides

Blueprint

Plugins

Upgrade

Sign in

Create account

Move from the legacy products to the new Flatfile Platform

Overview

Flatfile

Explore our guides and examples to implement Flatfile.

A selection of example projects to get started with.

Example Projects

Additions and updates to the Flatfile platform

Platform

SDKs

Additions and updates to Flatfile plugins

Get up and running with Flatfile in this step by step guide

Getting started

Configure a destination for your data by creating a Workbook

Meet the Workbook

Learn how to listen and respond to events in Flatfile.

Setup a listener

Add validations and transformations to your listeners

Transform and validate data

Create a simple submit Action to export your data

Configure a submit Action

Publish your code to Flatfile and move beyond this simple sandbox

Deploy to Flatfile

Learn how to process data with Data Hooks

Handling data

Using actions

Dynamically build your Space configuration as it's created.

Dynamically configure anything

Narrow down the scope of Spaces, Workbooks, and Sheets.

Scoping with Namespaces

Store descriptive information or data that provides additional context.

Utilizing metadata

Egress out

Learn how to customize the look and feel of Flatfile to match your brand.

Theme your Space

Learn how to limit what Guests see in their sidebar.

Customize the guest sidebar

Learn how to build pages in your sidebar with Documents.

Build Documents

Learn how to securely use credentials in listeners.

Share secrets

Learn how to automatically map your data fields.

Automate with automap

Translate and customize your Space with text overrides

Translating your Space

Additional fields

Workbooks

Actions

Jobs

Events

Spaces

Listeners

Securely and easily build an embedded Flatfile import experience into your client-side application

Learn how to configure Flatfile to deliver a completely automated data import experience.

Automate with headless

Use Flatfile in a collaborative data onboarding project with your customer.

Run onboarding projects

Blueprint is a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.

Configure the basic behavior of your Sheet

Sheet options

Field Types inform the user interface how to sort and display data.

Types

Constraints

Relationships

Controlling user interactions with your Sheets and fields

Access

Quickstart Portal 2 Upgrade

Portal 2 <-> Platform Concepts

Repo on GitHub

Upgrading from v3

Upgrade with @flatfile/configure

Learn how to use Environments for testing and authentication.

Using environments

Running on your local machine

Check for agents

Create an environment

Learn how to deploy your code to Flatfile.

Deploying to Flatfile

Understanding client-side and server-side operations in Flatfile.

Listener operations

Learn how to filter data in Sheets with FFQL.

Flatfile query language

Learn versioning principles for npm packages at Flatfile.

Versioning principles

Learn how to use API keys to authenticate API requests.

Authentication

Learn how to authenticate above the Environment level.

Personal Access Token

Learn how to give your team and customers access.

Roles & permissions

flatfile

@flatfile/listener

@flatfile/api

flatfile-python

@flatfile/react

@flatfile/angular

@flatfile/vue

@flatfile/javascript

Use one of our plugins to add functionality to your Flatfile data engine.

A plugin for parsing Excel files in Flatfile

@flatfile/plugin-xlsx-extractor

A plugin for parsing .json files in Flatfile.

@flatfile/plugin-json-extractor

A plugin for parsing .xml files in Flatfile.

@flatfile/plugin-xml-extractor

A plugin for parsing .zip files in Flatfile.

@flatfile/plugin-zip-extractor

A plugin for parsing .delimiter files in Flatfile.

@flatfile/plugin-delimiter-extractor

A plugin for parsing .pdf files in Flatfile.

@flatfile/plugin-pdf-extractor

A plugin for parsing .doc files in Flatfile.

@flatfile/plugin-doc-extractor

A plugin for running custom logic on individual data records in Flatfile.

@flatfile/plugin-record-hook

A plugin for automatically casting values in Flatfile.

@flatfile/plugin-autocast

Dedupe records in a sheet via a sheet level custom action.

@flatfile/plugin-dedupe

A plugin to provide automapping imported files for headless workflows.

@flatfile/plugin-automap

A plugin for exporting data in Flatfile to Workbooks.

@flatfile/plugin-export-workbook

A plugin for egressing data from a Flatfile Workbook to a webhook.

@flatfile/plugin-webhook-egress

A plugin for converting JSON Schema to Flatfile Blueprint and configuring a Flatfile Space.

@flatfile/plugin-convert-json-schema

A plugin for converting YAML Schema to Flatfile Blueprint.

@flatfile/plugin-convert-yaml-schema

A plugin for converting Open API to Flatfile Blueprint.

@flatfile/plugin-openapi

A plugin for converting Graphql to Flatfile Blueprint.

@flatfile/plugin-graphql

A plugin for converting SQL DDL to Flatfile Blueprint.

@flatfile/plugin-sql-ddl

A plugin that populates a Sheet with 5-digit zip codes.

@flatfile/dataset-zipcodes

A plugin that populates a Sheet with the countries of the World.

@flatfile/dataset-countries

A plugin for using DXP class-based configurations.

@flatfile/plugin-dxp-configure

@flatfile/plugin-job-handler

A plugin for configuring Flatfile Spaces.

@flatfile/plugin-space-configure

A shared utility for defining a data extraction.

@flatfile/util-extractor

A shared utility for processing files and extracting their contents using the Flatfile API.

@flatfile/util-file-buffer

A shared utility for handling response rejections.

Upgrade

Portal - version 2

Portal - version 3

Overview

Resources

Portal 3.0

Upgrading from v3

Example Repo

Portal 2.0

Upgrading from v2

Example Repo

Upgrade

Portal - version 2

Portal - version 3

​Resources

​Portal 3.0

Upgrading from v3

Example Repo

​Portal 2.0

Upgrading from v2

Example Repo

Resources

Portal 3.0

Portal 2.0