Flatfile API Documentation

This is the complete API documentation for connecting to the Flatfile API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet Flatfile: Flatfile API integration for managing environments, spaces, workbooks, sheets, records, files, jobs, users, views, documents, snapshots, and data clips. Keep reading to get started.

Quickstart

Before you run your first Flatfile request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one Flatfile connection — create or choose one in Connections. Note its connectionId.

Every Flatfile action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/flatfile/actions/{actionSlug}/run

You need a MindCloud API Key and a Flatfile connection. Then call an action such as List Environments:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/flatfile/actions/list-environments/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your Flatfile account. See Flatfile API Authentication for the full flow and how to get your connection credentials.

Flatfile actions

All 51 published actions for this Flatfile version. Each page documents the endpoint, arguments, and response controls.

• PUTAcknowledge Job
• PUTArchive Space
• PUTBulk Update Records
• POSTClone File
• PUTComplete Job
• POSTCreate Job
• POSTCreate Space
• POSTCreate Workbook
• DELETEDelete File
• DELETEDelete Job
• DELETEDelete Records
• DELETEDelete Sheet
• DELETEDelete Space
• DELETEDelete Workbook
• POSTDetect File Header
• GETDownload File
• POSTDuplicate Sheet
• PUTExecute Job
• PUTFind And Replace Records
• GETGet Cell Values
• GETGet Current Account
• GETGet Environment
• GETGet File
• GETGet Job
• GETGet Job Execution Plan
• GETGet Publishable Key
• GETGet Record Counts
• GETGet Record Indices
• GETGet Records
• GETGet Sheet
• GETGet Sheet Commits
• GETGet Space
• GETGet Workbook
• GETGet Workbook Commits
• POSTInsert Records
• GETList Calculations
• GETList Environments
• GETList Files
• GETList Jobs
• GETList Sheets
• GETList Spaces
• GETList Workbooks
• PUTUnarchive Space
• PUTUpdate File
• PUTUpdate Job
• PUTUpdate Records
• PUTUpdate Sheet
• PUTUpdate Space
• PUTUpdate Workbook
• POSTUpload File
• PUTValidate Sheet

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp