Community
Create Account
Sign in
Search...
/
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
GET
Get the current account
PATCH
Update the current account
Agents
GET
List agents
POST
Create an agent
GET
Get an agent
GET
List Agent Roles
POST
Assign Role to Agent
DEL
Remove Role from Agent
GET
Get logs for an agent
GET
Get an agent log
GET
Get all agent logs in your environment
GET
Get all executions in your environment
DEL
Delete an agent
Apps
GET
List apps
GET
Get an app
PATCH
Update an app
POST
Create an app
DEL
Delete an app
Assistant
GET
List prompts
GET
Get a prompt
PATCH
Update a prompt
POST
Create a prompt
DEL
Delete a prompts
Commits
GET
Get a commit version
POST
Complete a commit version
POST
Replay a commit version
Data Retention Policies
GET
List data retention policies
POST
Create a data retention policy
GET
Get a data retention policy
PATCH
Update a data retention policy
DEL
Delete a data retention policy
Documents
GET
List documents
POST
Create a document
GET
Get a document
PATCH
Update a document
DEL
Delete a document
Entitlements
GET
List entitlements
Environments
GET
List environments
POST
Create an environment
GET
Get environment subscription credentials
GET
Get an environment
PATCH
Update an environment
DEL
Delete an environment
Events
GET
List events
POST
Create an event
GET
Get an event
POST
Acknowledge an event
GET
Get subscription credentials
Files
GET
List files
POST
Upload a file
GET
Get a file
DEL
Delete a file
PATCH
Update a file
GET
Download a file
Guests
GET
List guests
POST
Create a guest
GET
Get a guest
DEL
Delete a guest
PATCH
Update a guest
GET
Get guest token
GET
List Guest Roles
POST
Assign Role to Guest
DEL
Remove Role from Guest
POST
Invite guests
Jobs
GET
List jobs
POST
Create a job
GET
Get a job
PATCH
Update a job
DEL
Delete a job
POST
Execute a job
GET
Get a job's execution plan
PUT
Replace a job's plan
PATCH
Update a job's plan
POST
Acknowledge a job
POST
Acknowledge a job outcome
POST
Complete a job
POST
Fail a job
POST
Cancel a job
POST
Retry a failed job
POST
Preview a mutation
POST
Split a job
Mapping
POST
Create a mapping between two schemas
DEL
Delete all history for the authenticated user
GET
List mapping programs
GET
Get a mapping program
PATCH
Update a mapping program
DEL
Delete a mapping program
POST
Add mapping rules to a program
DEL
Delete multiple mapping rules
GET
List mapping rules
GET
Get a mapping rule
PATCH
Update a mapping rule
PATCH
Update a list of mapping rules
DEL
Delete a mapping rule
Records
GET
Get records
PUT
Update records
POST
Insert records
DEL
Delete records
PUT
Finds and replaces field values matching search criteria
Roles
GET
List roles
Secrets
GET
List secrets
POST
Upsert a Secret
DEL
Delete a secret by it's Id
Sheets
GET
List sheets
GET
Get a sheet
DEL
Delete a sheet
POST
Validate a sheet
GET
Download records as a CSV file
GET
Get record counts
GET
Get commit versions for a sheet
POST
Lock a sheet
POST
Unlock a sheet
GET
Get record cells by field
PATCH
Update a sheet
Snapshots
POST
Create a snapshot
GET
List snapshots
GET
Get a snapshot
DEL
Delete a snapshot
POST
Restore a snapshot
GET
Get records from a snapshot
Spaces
GET
List spaces
POST
Create a space
GET
Get a space
DEL
Delete a space
DEL
Delete spaces
PATCH
Update a space
POST
Archives a space
Users
GET
List users
POST
Create and Invite User
POST
Resend User Invite
PATCH
Update a user
GET
Get a user
DEL
Delete a user
GET
List User Roles
POST
Assign Role to User
DEL
Remove Role from User
Versions
POST
Create Id
Views
GET
List views by Sheet
POST
Create a view
GET
Get a view
PATCH
Update a view
DEL
Delete a view
Workbooks
GET
List workbooks
POST
Create a workbook
GET
Get a workbook
DEL
Delete a workbook
PATCH
Update a workbook
GET
Get commits for a workbook
Community
Create Account
Sign in
Versions
Create Id
Deprecated
POST
https://
api.x.flatfile.com
/
v1
/
versions
Request
This endpoint expects an object.
sheetId
string
Optional
The ID of the Sheet.
parentVersionId
string
Optional
Deprecated, creating or updating a group of records together will automatically generate a commitId to group those record changes together.
Response
This endpoint returns an object
data
object
Show property
Built with