Skip to main content
Flatfile logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: FLATFILE
  • Version: 20261101_00

Tools

Slug: FLATFILE_DELETE_RECORDSPermanently 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

string
required
ID of the sheet containing the records.
array
required
One to 100 exact record IDs to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_GET_JOBGet detailed status, outcome, result, and diagnostic information for one Flatfile asynchronous job.

Input Parameters

string
required
ID of the Flatfile job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_GET_SHEETGet one sheet’s field configuration and any available precomputed record counts before reading or writing records.

Input Parameters

string
required
ID of the Flatfile sheet to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_GET_SPACEGet metadata for one Flatfile space, omitting its access token and guest link and removing similarly named fields from nested metadata.

Input Parameters

string
required
ID of the Flatfile space to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_INSERT_RECORDSInsert 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

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.
string
required
ID of the destination sheet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_ENVIRONMENTSList Flatfile environments visible to the connected environment secret key and return the IDs needed to find spaces.

Input Parameters

string
Continuation cursor from a previous response; omit for the first page.
integer
Maximum environments to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_FILESDiscover import or export files and their processing status, optionally within a Flatfile space.

Input Parameters

string ("import" | "export")
Storage mode of files to discover.
string
Continuation cursor from a previous response; omit for the first page.
string
Only return files in this space.
integer
Maximum files to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_JOBSFind 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

string
Continuation cursor from a previous response; omit for the first page.
string
ID of the file, workbook, sheet, or app that originated the job; prefer the corresponding typed ID filter when available.
string
Only return jobs for this file.
string
Only return jobs in this space.
integer
Maximum jobs to return in this page.
string
Only return jobs for this workbook.
string
Only return child jobs of this parent job.
string
Only return jobs in this environment.
string ("asc" | "desc")
Sort jobs in ascending or descending order.
boolean
Return only top-level jobs unless a parent job is specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_RECORDSRead 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

string
Flatfile FFQL expression for advanced filtering.
string
Continuation cursor returned by an earlier call. Omit for the first page.
array
Field keys to include; omit to return all fields.
string ("valid" | "error" | "all" | "none")
Validity filter: valid, error, all, or none.
string
required
ID of the sheet whose records should be read.
integer
Maximum records to return in this page. Use moderate page sizes.
array
Up to 100 record IDs to include for unfiltered reads or exclude when another filter is active.
string
Field key used with the validity filter.
string
Field key to restrict the search.
string
Value to search for in records.
Whether cell values should include linked records.
boolean
Whether cells should include validation messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_SPACESFind Flatfile spaces by environment, text, namespace, archive state, or template status.

Input Parameters

string
Continuation cursor from a previous response. Omit for the first page.
Search space names and supported text fields.
boolean
Whether archived spaces should be included.
string
Only return spaces with this namespace.
integer
Maximum spaces to return in this page.
string
Only return spaces in this environment.
boolean
Filter by whether the space is an app template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_LIST_WORKBOOKSList workbooks, optionally within a space, with their nested sheets so an agent can continue to sheet and record tasks.

Input Parameters

string
Filter by workbook name; prefix with ’-’ for provider-supported negation.
string
Filter by workbook label; prefix with ’-’ for negation.
string
Only return workbooks belonging to this space.
string
Filter by workbook namespace; prefix with ’-’ for negation.
boolean
Include nested sheet IDs and schemas in each workbook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FLATFILE_UPDATE_RECORDSUpdate 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

array
required
One or more record updates, each with a required record ID and values.
string
required
ID of the sheet containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not