> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Flatfile

> Flatfile is a data exchange platform for collecting, validating, transforming, and managing structured data across collaborative workflows.

![Flatfile logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/flatfile.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=dbd8eecd0ff03e4e06867eed083ed9c8)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `FLATFILE`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete Records
>
> **Slug:** `FLATFILE_DELETE_RECORDS`
>
> Permanently delete one to 100 explicitly identified records from one Flatfile sheet. This action never performs an unfiltered delete. Flatfile hooks are disabled, so these deletions do not trigger hook-driven workflows.
>
> #### Input Parameters
>
> **sheet\_id** `string` *required*
>
> ID of the sheet containing the records.
>
> **record\_ids** `array` *required*
>
> One to 100 exact record IDs to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Job
>
> **Slug:** `FLATFILE_GET_JOB`
>
> Get detailed status, outcome, result, and diagnostic information for one Flatfile asynchronous job.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> ID of the Flatfile job to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Sheet
>
> **Slug:** `FLATFILE_GET_SHEET`
>
> Get one sheet's field configuration and any available precomputed record counts before reading or writing records.
>
> #### Input Parameters
>
> **sheet\_id** `string` *required*
>
> ID of the Flatfile sheet to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Space
>
> **Slug:** `FLATFILE_GET_SPACE`
>
> Get metadata for one Flatfile space, omitting its access token and guest link and removing similarly named fields from nested metadata.
>
> #### Input Parameters
>
> **space\_id** `string` *required*
>
> ID of the Flatfile space to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Insert Records
>
> **Slug:** `FLATFILE_INSERT_RECORDS`
>
> Insert one or more rows into a Flatfile sheet using simple field-key to value objects, with hooks disabled. Returns a success receipt and any commit ID provided, but not created record IDs.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> Rows to insert, keyed by sheet field key. Each value may be a string, number, boolean, ISO date or date-time string, or string array.
>
> **sheet\_id** `string` *required*
>
> ID of the destination sheet.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Environments
>
> **Slug:** `FLATFILE_LIST_ENVIRONMENTS`
>
> List Flatfile environments visible to the connected environment secret key and return the IDs needed to find spaces.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **page\_size** `integer`
>
> Maximum environments to return in this page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Files
>
> **Slug:** `FLATFILE_LIST_FILES`
>
> Discover import or export files and their processing status, optionally within a Flatfile space.
>
> #### Input Parameters
>
> **mode** `string ("import" | "export")`
>
> Storage mode of files to discover.
>
> **cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **space\_id** `string`
>
> Only return files in this space.
>
> **page\_size** `integer`
>
> Maximum files to return in this page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Jobs
>
> **Slug:** `FLATFILE_LIST_JOBS`
>
> Find asynchronous Flatfile jobs by environment, space, workbook, file, or parent job and inspect progress at a glance. By default, child jobs are excluded unless a parent job is specified.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor from a previous response; omit for the first page.
>
> **source** `string`
>
> ID of the file, workbook, sheet, or app that originated the job; prefer the corresponding typed ID filter when available.
>
> **file\_id** `string`
>
> Only return jobs for this file.
>
> **space\_id** `string`
>
> Only return jobs in this space.
>
> **page\_size** `integer`
>
> Maximum jobs to return in this page.
>
> **workbook\_id** `string`
>
> Only return jobs for this workbook.
>
> **parent\_job\_id** `string`
>
> Only return child jobs of this parent job.
>
> **environment\_id** `string`
>
> Only return jobs in this environment.
>
> **sort\_direction** `string ("asc" | "desc")`
>
> Sort jobs in ascending or descending order.
>
> **exclude\_child\_jobs** `boolean`
>
> Return only top-level jobs unless a parent job is specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Records
>
> **Slug:** `FLATFILE_LIST_RECORDS`
>
> Read one page of records from a Flatfile sheet, optionally filtering by validity, field, record ID, search value, or FFQL expression. Record IDs include specified records in basic queries but exclude them when dataset filters are applied.
>
> #### Input Parameters
>
> **query** `string`
>
> Flatfile FFQL expression for advanced filtering.
>
> **cursor** `string`
>
> Continuation cursor returned by an earlier call. Omit for the first page.
>
> **fields** `array`
>
> Field keys to include; omit to return all fields.
>
> **filter** `string ("valid" | "error" | "all" | "none")`
>
> Validity filter: valid, error, all, or none.
>
> **sheet\_id** `string` *required*
>
> ID of the sheet whose records should be read.
>
> **page\_size** `integer`
>
> Maximum records to return in this page. Use moderate page sizes.
>
> **record\_ids** `array`
>
> Up to 100 record IDs to include for unfiltered reads or exclude when another filter is active.
>
> **filter\_field** `string`
>
> Field key used with the validity filter.
>
> **search\_field** `string`
>
> Field key to restrict the search.
>
> **search\_value** `string`
>
> Value to search for in records.
>
> **include\_links** `boolean`
>
> Whether cell values should include linked records.
>
> **include\_messages** `boolean`
>
> Whether cells should include validation messages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Spaces
>
> **Slug:** `FLATFILE_LIST_SPACES`
>
> Find Flatfile spaces by environment, text, namespace, archive state, or template status.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor from a previous response. Omit for the first page.
>
> **search** `string`
>
> Search space names and supported text fields.
>
> **archived** `boolean`
>
> Whether archived spaces should be included.
>
> **namespace** `string`
>
> Only return spaces with this namespace.
>
> **page\_size** `integer`
>
> Maximum spaces to return in this page.
>
> **environment\_id** `string`
>
> Only return spaces in this environment.
>
> **is\_app\_template** `boolean`
>
> Filter by whether the space is an app template.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workbooks
>
> **Slug:** `FLATFILE_LIST_WORKBOOKS`
>
> List workbooks, optionally within a space, with their nested sheets so an agent can continue to sheet and record tasks.
>
> #### Input Parameters
>
> **name** `string`
>
> Filter by workbook name; prefix with '-' for provider-supported negation.
>
> **label** `string`
>
> Filter by workbook label; prefix with '-' for negation.
>
> **space\_id** `string`
>
> Only return workbooks belonging to this space.
>
> **namespace** `string`
>
> Filter by workbook namespace; prefix with '-' for negation.
>
> **include\_sheets** `boolean`
>
> Include nested sheet IDs and schemas in each workbook.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Records
>
> **Slug:** `FLATFILE_UPDATE_RECORDS`
>
> Update one or more existing Flatfile records by ID using simple field-key to value objects. Flatfile hooks are disabled, so these updates do not trigger hook-driven workflows.
>
> #### Input Parameters
>
> **records** `array` *required*
>
> One or more record updates, each with a required record ID and values.
>
> **sheet\_id** `string` *required*
>
> ID of the sheet containing the records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
