Example0

Get the current account

Update the current account

Accounts

List agents

Agent Response

Error Response

Create an agent

Get an agent

List Agent Roles

Assign Role to Agent

Remove Role from Agent

Get logs for an agent

Get an agent log

Get all agent logs in your environment

Get all executions in your environment

Delete an agent

Agents

List apps

Get an app

Update an app

Create an app

Apps

List prompts

Number of prompts to return in a page (default 7)

Based on pageSize, which page of prompts to return

Get a prompt

Update a prompt

Create a prompt

Delete a prompts

Assistant

Get a commit version

Completes a commit version. This marks the commit as complete and acknowledges that the changes have been applied to the sheet.

Complete a commit version

Replay a commit version

ID of the commit version to re-emit a commit:created event for

Commits

Returns all data retention policies on an account matching a filter for environmentId

List data retention policies

The associated Environment ID of the policy.

Add a new data retention policy to the space

Create a data retention policy

Get a data retention policy

Update a data retention policy

Delete a data retention policy

Data Retention Policies

List documents

Create a document

Get a document

updates a single document, for only the body and title

Update a document

Delete a document

Documents

Returns all entitlements matching a filter for resourceId

List entitlements

The associated Resource ID for the entitlements.

Entitlements

List environments

Number of environments to return in a page (default 10)

Based on pageSize, which page of environments to return

Create an environment

Get a token which can be used to subscribe to events for this environment

Get environment subscription credentials

Get an environment

Updates a single environment, to change the name for example

Update an environment

Delete an environment

Environments

Event topics that the Flatfile Platform emits.

List events

Number of results to return in a page (default 10)

Based on pageSize, which page of results to return

Create an event

Get an event

Acknowledge an event

Get a token which can be used to subscribe to events for this space

Get subscription credentials

The resource ID of the event stream (space or environment id)

Events

List files

Number of files to return in a page (default 20)

Based on pageSize, which page of files to return

The storage mode of file to fetch, defaults to "import"

Upload a file

Get a file

Delete a file

Update a file, to change the workbook id for example

Update a file

Download a file

Files

List guests

Guests are only there to upload, edit, and download files and perform their tasks in a specific Space.

Create a guest

Get a guest

Delete a guest

Updates a single guest, for example to change name or email

Update a guest

Get guest token

List Guest Roles

Assign Role to Guest

Remove Role from Guest

Guests can be created as a named guest on the Space or there’s a global link that will let anonymous guests into the space.

Invite guests

Guests

List jobs

When provided, only jobs for the given environment will be returned

When provided, only jobs for the given space will be returned

When provided, only jobs for the given workbook will be returned

When provided, only jobs for the given file will be returned

When provided, only jobs that are parts of the given job will be returned

Number of jobs to return in a page (default 20)

Based on pageSize, which page of jobs to return

Sort direction - asc (ascending) or desc (descending)

Create a job

Get a job

Update a job

Delete a job

Execute a job

Get a job's execution plan

Replace a job's plan

Update one or more individual fields on a job's execution plan

Update a job's plan

Acknowledge a job

Acknowledge a job outcome and return the job

Acknowledge a job outcome

Complete a job

Fail a job

Cancel a job

Retry a failed job

Preview a mutation

Split a job

Jobs

Creates a list of mapping rules based on two provided schemas

Create a mapping between two schemas

Deletes all history for the authenticated user

Delete all history for the authenticated user

List mapping programs

Number of programs to return in a page (default 10)

Based on pageSize, which page of records to return

Get a mapping program

Update a mapping program

Delete a mapping program

Add mapping rules to a program

List mapping rules

Get a mapping rule

Update a mapping rule

Updates a list of mapping rules in a program

Update a list of mapping rules

Delete a mapping rule

Mapping

Returns records from a sheet in a workbook

Get records

The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records. Maximum of 100 allowed.

Number of records to return in a page (default 10,000)

Based on pageSize, which page of records to return (Note - numbers start at 1)

The length of the record result set, returned as counts.total

If true, linked records will be included in the results. Defaults to false.

Include error messages, defaults to false.

if "for" is provided, the query parameters will be pulled from the event payload

An FFQL query used to filter the result set

Updates existing records in a workbook sheet

Update records

Insert records

Delete records

A list of record IDs to delete. Maximum of 100 allowed.

Searches for all values that match the 'find' value (globally or for a specific field via 'fieldKey') and replaces them with the 'replace' value. Wrap 'find' value in double quotes for exact match (""). Returns a commitId for the updated records

Finds and replaces field values matching search criteria


The Record Ids param (ids) is a list of record ids that can be passed to several record endpoints allowing the user to identify specific records to INCLUDE in the query, or specific records to EXCLUDE, depending on whether or not filters are being applied. When passing a query param that filters the record dataset, such as 'searchValue', or a 'filter' of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from the filtered results. For basic queries that do not filter the dataset, passing record ids in the 'ids' param will limit the dataset to INCLUDE just those specific records

Records

List roles

Roles

Fetch all secrets for a given environmentId and optionally apply space overrides

List secrets

Insert or Update a Secret by name for environment or space

Upsert a Secret

Deletes a specific Secret from the Environment or Space as is the case

Delete a secret by it's Id

Secrets

List sheets

Get a sheet

Delete a sheet

Trigger data hooks and validation to run on a sheet

Validate a sheet

Returns records from a sheet in a workbook as a csv file

Download records as a CSV file

Returns records that were changed in that version in that version and only those records.

Returns records that were changed in that version in addition to any records from versions after that version.

Get record counts

Returns records that were changed in that version and only those records.

Listing a commit ID here will return all records since the specified commit.

If true, the counts for each field will also be returned

An FFQL query used to filter the result set to be counted

Get commit versions for a sheet

If true, only return commits that have been completed. If false, only return commits that have not been completed. If not provided, return all commits.

Lock a sheet

Unlock a sheet

Returns record cell values grouped by all fields in the sheet

Get record cells by field

Number of records to return in a page (default 1000 if pageNumber included)

A value to find for a given field in a sheet. Wrap the value in "" for exact match

Overview

API Reference

Delete records

Path parameters

Query parameters

Response

Errors

$	curl -X DELETE "https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID/records?ids=us_rc_YOUR_ID" \
>	-H "Authorization: Bearer <token>"

1	{
2	"data": {
3	"success": true
4	}
5	}