# Flatfile integration

> Data import platform API: manage spaces, workbooks, sheets, records, files, jobs, agents, and events for Flatfile data onboarding.

- Authentication: apiKey

## Tools (221)

- **Acknowledge a job**: Acknowledge a job and return the job
- **Acknowledge a job outcome**: Acknowledge a job outcome and return the job
- **Acknowledge an event**: Acknowledge an event
- **Add mapping rules to a program**: Add mapping rules to a program
- **Add Records To Clip**: Adds records to an existing DataClip.
- **Archives a space**: Sets archivedAt timestamp on a space
- **Assign Role to Agent**: Assigns a role to a agent.
- **Assign Role to Guest**: Assigns a role to a guest.
- **Assign Role to User**: Assigns a role to a user.
- **Bulk Mutate**: Performs bulk flag operations on records
- **Bulk update records with field values
**: Updates multiple records at once with the same field values based on filter criteria.
- **Cancel a job**: Cancel a job and return the job
- **Clone a file**: Clone a file
- **Complete 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 job**: Complete a job and return the job
- **Create a canvas area**: Creates a new canvas area
- **Create a data retention policy**: Add a new data retention policy to the space
- **Create a document**: Add a new document to the space
- **Create a draft of a space**: Creates a draft of a space
- **Create a guest**: Guests are only there to upload, edit, and download files and perform their tasks in a specific Space.
- **Create a guide**: Creates a guide
- **Create a job**: Create a job
- **Create a mapping between two schemas**: Creates a list of mapping rules based on two provided schemas
- **Create an action**: Create an action
- **Create an agent**: Create an agent
- **Create an app**: Creates an app
- **Create and Invite User**: Creates and invites a new user to your account.
- **Create an environment**: Create a new environment
- **Create an event**: Create an event
- **Create a new guidance**: Creates a new guidance
- **Create a prompt**: Creates a prompt
- **Create a routine**: Creates a new routine
- **Create a runbook**: Creates a new runbook
- **Create a snapshot**: Creates a snapshot of a sheet
- **Create a space**: Creates a new space based on an existing Space Config
- **Create a view**: Add a new view to the space
- **Create a workbook**: Creates a workbook and adds it to a space
- **Create constraint**: Creates a new constraint for an app
- **Create (Data Clip)**: Creates a new DataClip.
- **Create (Flag)**: Creates a new flag for the workbook
- **Create several actions**: Create several actions
- **Delete a canvas area**: Deletes a specific canvas area
- **Delete a data retention policy**: Deletes a single data retention policy
- **Delete a document**: Deletes a single document
- **Delete a file**: Delete a file
- **Delete a guest**: Deletes a single guest or removes guest access from a specific space
- **Delete a guidance**: Deletes a guidance by its id
- **Delete a guide**: Deletes a guide
- **Delete a job**: Delete a job
- **Delete all history for the authenticated user**: Deletes all history for the authenticated user
- **Delete a mapping program**: Deletes a mapping program
- **Delete a mapping rule**: Deletes a mapping rule from a program
- **Delete an action**: Delete an action
- **Delete an agent**: Deletes a single agent
- **Delete an agent export**: Delete an agent export
- **Delete an app**: Deletes an app
- **Delete an environment**: Deletes a single environment
- **Delete a prompts**: Deletes a prompts
- **Delete a routine**: Deletes a routine
- **Delete a runbook**: Deletes a runbook
- **Delete a secret by it's Id**: Deletes a specific Secret from the Environment or Space as is the case
- **Delete a sheet**: Deletes a specific sheet from a workbook
- **Delete a snapshot**: Deletes a snapshot of a sheet
- **Delete a space**: Delete a space
- **Delete a user**: Deletes a user
- **Delete a view**: Deletes a single view
- **Delete a workbook**: Deletes a workbook and all of its record data permanently
- **Delete constraint**: Deletes a specific constraint
- **Delete (Data Clip)**: Delete
- **Delete (Flag)**: Deletes a flag
- **Delete multiple mapping rules**: Deletes multiple mapping rules from a program
- **Delete records**: Deletes records from a workbook sheet
- **Delete spaces**: Delete multiple spaces by id
- **Detect header**: Detect header
- **Download a file**: Download a file
- **Download an agent export**: Download an agent export
- **Download records as a CSV file**: Returns records from a sheet in a workbook as a csv file
- **Duplicate a sheet**: Creates a copy of a sheet including all its data within the same workbook
- **Execute a job**: Execute a job and return the job
- **Fail a job**: Fail a job and return the job
- **Finds and replaces field values matching search criteria
**: Searches for all values that match the 'find' value (globally or for a specific field via 'fieldKey') and replaces them with the 'replace' value.
- **Get a canvas area**: Returns a specific canvas area by ID
- **Get a commit version**: Returns the details of a commit version
- **Get a data retention policy**: Returns a single data retention policy
- **Get a document**: Returns a single document
- **Get a draft**: Gets a draft by the space id and draft space id
- **Get a file**: Get a file
- **Get a guest**: Returns a single guest
- **Get a guidance**: Retrieves a guidance by its id
- **Get a guide**: Returns a guide
- **Get a job**: Get a job
- **Get a job's execution plan**: Returns a single job's execution plan
- **Get all actions for the space**: Get all actions for the space
- **Get all agent logs in your environment**: Get all agent logs in your environment
- **Get all executions in your environment**: Get all executions in your environment
- **Get a mapping program**: Get a mapping program
- **Get a mapping rule**: Get a mapping rule from a program
- **Get an action**: Get an action
- **Get an agent**: Get an agent
- **Get an agent export**: Get an agent export
- **Get an agent log**: Get an agent log
- **Get an app**: Returns an app
- **Get an environment**: Returns a single environment
- **Get an event**: Get an event
- **Get a prompt**: Returns a prompt
- **Get a routine**: Returns a routine
- **Get a runbook**: Returns a runbook
- **Get a sheet**: Returns a sheet in a workbook
- **Get a snapshot**: Gets a snapshot of a sheet
- **Get a space**: Returns a single space
- **Get a user**: Gets a user
- **Get a view**: Returns a single view
- **Get a workbook**: Returns a single workbook
- **Get commits for a workbook**: Returns the commits for a workbook
- **Get commit versions for a sheet**: Returns the commit versions for a sheet
- **Get constraint by ID**: Returns a specific constraint
- **Get constraints**: Returns constraints for an app
- **Get constraint version**: Returns a specified version of a specific constraint
- **Get constraint versions**: Returns the versions of a specific constraint
- **Get (Data Clip)**: Get
- **Get environment subscription credentials**: Get a token which can be used to subscribe to events for this environment
- **Get (Flag)**: Gets a specific flag by its slug
- **Get guest token**: Returns a single guest token
- **Get guide version**: Returns a specified version of a specific guide
- **Get logs for an agent**: Get logs for an agent
- **Get record cells by field**: Returns record cell values grouped by all fields in the sheet
- **Get record counts**: Returns counts of records from a sheet
- **Get record Indices**: Returns indices of records from a sheet in a workbook
- **Get records**: Returns records from a sheet in a workbook
- **Get records from a snapshot**: Gets records from a snapshot of a sheet
- **Get Resolution Index**: Get Resolution Index
- **Get Resolutions**: Get Resolutions
- **Get SFTP credentials for Space**: Get SFTP credentials for Space
- **Get subscription credentials**: Get a token which can be used to subscribe to events for this space
- **Get the current account**: Get the current account
- **Insert records**: Adds records to a workbook sheet
- **Invite guests**: 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.
- **List agent exports**: List agent exports
- **List Agent Roles**: Lists roles assigned to an agent.
- **List agents**: List agents
- **List agent versions for an agent**: List agent versions for an agent
- **List apps**: Returns apps in an account
- **List calculations**: Returns all calculations for a sheet
- **List canvas areas**: Returns a list of canvas areas filtered by canvas, space, or environment
- **List (Data Clip)**: List
- **List data retention policies**: Returns all data retention policies on an account matching a filter for environmentId
- **List documents**: Returns all documents for a space
- **List drafts for a space**: Lists drafts for a space
- **List entitlements**: Returns all entitlements matching a filter for resourceId
- **List environments**: Get all environments
- **List events**: Event topics that the Flatfile Platform emits.
- **List files**: List files
- **List (Flag)**: Gets all flags for the workbook
- **List Guest Roles**: Lists roles assigned to a guest.
- **List guests**: Returns all guests
- **List guidances**: Lists guidances
- **List guides**: Returns guides in an account
- **List jobs**: List jobs
- **List mapping programs**: List all mapping programs
- **List mapping rules**: List all mapping rules in a program
- **List prompts**: Returns prompts created by user
- **List roles**: List all roles for an account
- **List routines**: Returns a list of routines
- **List runbooks**: Returns a list of runbooks
- **List secrets**: Fetch all secrets for a given environmentId and optionally apply space overrides
- **List sheets**: Returns sheets in a workbook
- **List snapshots**: List all snapshots of a sheet
- **List spaces**: Returns all spaces for an account or environment
- **List User Roles**: Lists roles assigned to a user.
- **List users**: Gets a list of users
- **List views by Sheet**: Returns all views for the sheet
- **List workbooks**: Returns all workbooks matching a filter for an account or space
- **Lock a sheet**: Locks a sheet
- **Merge a draft**: Merges a draft into a space
- **Obtain the publishable key for a specific environment**: Obtain the publishable key for a specific environment
- **Preview a mutation**: Preview the results of a mutation
- **Refresh Resolutions**: Refresh Resolutions
- **Remove Role from Agent**: Removes a role from an agent.
- **Remove Role from Guest**: Removes a role from a guest.
- **Remove Role from User**: Removes a role from a user.
- **Replace a job's plan**: Update a job's entire execution plan
- **Replay a commit version**: Replays a commit:created event.
- **Resend User Invite**: Resends an invite to a user for your account.
- **Restore a snapshot**: Restores a snapshot of a sheet
- **Retry a failed job**: Retry a failt job and return the job
- **Revert to a specific agent version**: Revert to a specific agent version
- **Split a job**: Split a job and return the job
- **Unarchives a space**: Sets archivedAt timestamp on a space to null
- **Unlock a sheet**: Removes a lock from a sheet
- **Update a canvas area**: Updates an existing canvas area
- **Update a data retention policy**: Updates a single data retention policy
- **Update a document**: updates a single document, for only the body and title
- **Update a file**: Update a file, to change the workbook id for example
- **Update a guest**: Updates a single guest, for example to change name or email
- **Update a guidance**: Updates a guidance with the given id
- **Update a guide**: Updates a guide
- **Update a job**: Update a job
- **Update a job's plan**: Update one or more individual fields on a job's execution plan
- **Update a list of mapping rules**: Updates a list of mapping rules in a program
- **Update a mapping program**: Updates a mapping program
- **Update a mapping rule**: Updates a mapping rule in a program
- **Update an action**: Update an action
- **Update an app**: Updates an app
- **Update an environment**: Updates a single environment, to change the name for example
- **Update a prompt**: Updates a prompt
- **Update a routine**: Updates a routine
- **Update a runbook**: Updates a runbook
- **Update a sheet**: Updates Sheet
- **Update a space**: Update a space, to change the name for example
- **Update a user**: Updates a user
- **Update a view**: Updates a single view
- **Update a workbook**: Updates a workbook <Note> Adding a sheet to a workbook does not require the config object to be provided, however updating an existing sheet does. </Note>
- **Update constraint**: Updates a specific constraint
- **Update (Data Clip)**: Update
- **Update (Flag)**: Updates an existing flag
- **Update records**: Updates existing records in a workbook sheet
- **Update Resolution**: Update Resolution
- **Update the current account**: Update the current account
- **Upload a file**: Upload a file
- **Upsert a Secret**: Insert or Update a Secret by name for environment or space
- **Validate a sheet**: Trigger data hooks and validation to run on a sheet

Connect Flatfile in General Input: https://www.generalinput.com/apps/flatfile