{ "opencollection": "1.0.0", "info": { "name": "API Reference", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_accounts", "type": "folder" }, "items": [ { "info": { "name": "Get the current account", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/accounts/current", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ] }, "docs": "Get the current account" }, { "info": { "name": "Update the current account", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/accounts/current", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the current account" } ] }, { "info": { "name": "subpackage_actions", "type": "folder" }, "items": [ { "info": { "name": "Get all actions for the space", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/actions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "The Space ID for which to get the Actions." } ] }, "docs": "Get all actions for the space" }, { "info": { "name": "Create an action", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/actions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "The Space ID for which to create the Action." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an action" }, { "info": { "name": "Create several actions", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/actions/bulk", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "The Space ID for which to create the Actions." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create several actions" }, { "info": { "name": "Get an action", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/actions/:actionId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "actionId", "value": "", "type": "path", "description": "The id of the action to return" } ] }, "docs": "Get an action" }, { "info": { "name": "Update an action", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/actions/:actionId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "actionId", "value": "", "type": "path", "description": "The id of the action to patch" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an action" }, { "info": { "name": "Delete an action", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/actions/:actionId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "actionId", "value": "", "type": "path", "description": "The id of the action to delete" } ] }, "docs": "Delete an action" } ] }, { "info": { "name": "subpackage_agent-exports", "type": "folder" }, "items": [ { "info": { "name": "List agent exports", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agent-exports", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query" }, { "name": "agentId", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "List agent exports" }, { "info": { "name": "Get an agent export", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agent-exports/:agentExportId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentExportId", "value": "", "type": "path" } ] }, "docs": "Get an agent export" }, { "info": { "name": "Delete an agent export", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/agent-exports/:agentExportId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentExportId", "value": "", "type": "path" } ] }, "docs": "Delete an agent export" }, { "info": { "name": "Download an agent export", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agent-exports/:agentExportId/download", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentExportId", "value": "", "type": "path" } ] }, "docs": "Download an agent export" } ] }, { "info": { "name": "subpackage_agents", "type": "folder" }, "items": [ { "info": { "name": "List agents", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query" }, { "name": "isSystem", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "List agents" }, { "info": { "name": "Create an agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/agents", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an agent" }, { "info": { "name": "Get an agent", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/:agentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "query" } ] }, "docs": "Get an agent" }, { "info": { "name": "Delete an agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/agents/:agentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "query", "description": "This environment variable is no longer needed or used" } ] }, "docs": "Deletes a single agent" }, { "info": { "name": "List agent versions for an agent", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/:agentId/versions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path" } ] }, "docs": "List agent versions for an agent" }, { "info": { "name": "Revert to a specific agent version", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/:agentId/versions/:agentVersionId/revert", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path" }, { "name": "agentVersionId", "value": "", "type": "path" } ] }, "docs": "Revert to a specific agent version" }, { "info": { "name": "List Agent Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent id" } ] }, "docs": "Lists roles assigned to an agent." }, { "info": { "name": "Assign Role to Agent", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a role to a agent." }, { "info": { "name": "Remove Role from Agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/agents/:agentId/roles/:actorRoleId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "The agent id" }, { "name": "actorRoleId", "value": "", "type": "path", "description": "The actor role id" } ] }, "docs": "Removes a role from an agent." }, { "info": { "name": "Get logs for an agent", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/:agentId/logs", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "query" } ] }, "docs": "Get logs for an agent" }, { "info": { "name": "Get an agent log", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/log/:eventId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "eventId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "query" } ] }, "docs": "Get an agent log" }, { "info": { "name": "Get all agent logs in your environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/logs", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query" }, { "name": "spaceId", "value": "", "type": "query" }, { "name": "success", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "Get all agent logs in your environment" }, { "info": { "name": "Get all executions in your environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/agents/executions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query" }, { "name": "agentId", "value": "", "type": "query" }, { "name": "spaceId", "value": "", "type": "query" }, { "name": "success", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "Get all executions in your environment" } ] }, { "info": { "name": "subpackage_apps", "type": "folder" }, "items": [ { "info": { "name": "List apps", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ] }, "docs": "Returns apps in an account" }, { "info": { "name": "Create an app", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/apps", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an app" }, { "info": { "name": "Get an app", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps/:appId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of app" } ] }, "docs": "Returns an app" }, { "info": { "name": "Update an app", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/apps/:appId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of app" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an app" }, { "info": { "name": "Delete an app", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/apps/:appId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of app to delete" } ] }, "docs": "Deletes an app" }, { "info": { "name": "Get constraints", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "includeBuiltins", "value": "", "type": "query", "description": "Whether to include built-in constraints" } ] }, "docs": "Returns constraints for an app" }, { "info": { "name": "Create constraint", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new constraint for an app" }, { "info": { "name": "Get constraint by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints/:constraintId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "constraintId", "value": "", "type": "path", "description": "ID of the constraint" } ] }, "docs": "Returns a specific constraint" }, { "info": { "name": "Update constraint", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints/:constraintId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "constraintId", "value": "", "type": "path", "description": "ID of the constraint" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific constraint" }, { "info": { "name": "Delete constraint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints/:constraintId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "constraintId", "value": "", "type": "path", "description": "ID of the constraint" } ] }, "docs": "Deletes a specific constraint" }, { "info": { "name": "Get constraint versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints/:constraintId/versions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "constraintId", "value": "", "type": "path", "description": "ID of the constraint" } ] }, "docs": "Returns the versions of a specific constraint" }, { "info": { "name": "Get constraint version", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/apps/:appId/constraints/:constraintId/versions/:version", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "path", "description": "ID of the app" }, { "name": "constraintId", "value": "", "type": "path", "description": "ID of the constraint" }, { "name": "version", "value": "", "type": "path", "description": "Version of the constraint" } ] }, "docs": "Returns a specified version of a specific constraint" } ] }, { "info": { "name": "subpackage_assistant", "type": "folder" }, "items": [ { "info": { "name": "List prompts", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1//prompts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "promptType", "value": "", "type": "query", "description": "Type of prompt (default AI_ASSIST)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of prompts to return in a page (default 7)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of prompts to return" } ] }, "docs": "Returns prompts created by user" }, { "info": { "name": "Create a prompt", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1//prompts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a prompt" }, { "info": { "name": "Get a prompt", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1//prompts/:promptId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "promptId", "value": "", "type": "path", "description": "ID of prompts" } ] }, "docs": "Returns a prompt" }, { "info": { "name": "Update a prompt", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1//prompts/:promptId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "promptId", "value": "", "type": "path", "description": "ID of prompts" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a prompt" }, { "info": { "name": "Delete a prompts", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1//prompts/:promptId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "promptId", "value": "", "type": "path", "description": "ID of prompts" } ] }, "docs": "Deletes a prompts" } ] }, { "info": { "name": "subpackage_auth", "type": "folder" }, "items": [ { "info": { "name": "Obtain the publishable key for a specific environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/auth/publishable-key", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "ID of environment to search" } ] }, "docs": "Obtain the publishable key for a specific environment" }, { "info": { "name": "Get SFTP credentials for Space", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/auth/sftp-credentials", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "ID of space to get credentials for" } ] }, "docs": "Get SFTP credentials for Space" } ] }, { "info": { "name": "subpackage_canvas-areas", "type": "folder" }, "items": [ { "info": { "name": "List canvas areas", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/canvas-areas", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "canvasId", "value": "", "type": "query", "description": "ID of the canvas to filter areas by" }, { "name": "parentId", "value": "", "type": "query", "description": "ID of the parent canvas area to filter by" }, { "name": "spaceId", "value": "", "type": "query", "description": "ID of the space to filter areas by" }, { "name": "environmentId", "value": "", "type": "query", "description": "ID of the environment to filter areas by" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of areas to return in a page (default 20)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of areas to return" } ] }, "docs": "Returns a list of canvas areas filtered by canvas, space, or environment" }, { "info": { "name": "Create a canvas area", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/canvas-areas", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new canvas area" }, { "info": { "name": "Get a canvas area", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/canvas-areas/:canvasAreaId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "canvasAreaId", "value": "", "type": "path" } ] }, "docs": "Returns a specific canvas area by ID" }, { "info": { "name": "Update a canvas area", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/canvas-areas/:canvasAreaId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "canvasAreaId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing canvas area" }, { "info": { "name": "Delete a canvas area", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/canvas-areas/:canvasAreaId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "canvasAreaId", "value": "", "type": "path" } ] }, "docs": "Deletes a specific canvas area" } ] }, { "info": { "name": "subpackage_commits", "type": "folder" }, "items": [ { "info": { "name": "Get a commit version", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/commits/:commitId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "commitId", "value": "", "type": "path", "description": "ID of the commit version to return" } ] }, "docs": "Returns the details of a commit version" }, { "info": { "name": "Complete a commit version", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/commits/:commitId/complete", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "commitId", "value": "", "type": "path", "description": "ID of the commit version to complete" } ] }, "docs": "Completes a commit version. This marks the commit as complete and acknowledges that the changes have been applied to the sheet." }, { "info": { "name": "Replay a commit version", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/commits/:commitId/replay", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "commitId", "value": "", "type": "path", "description": "ID of the commit version to re-emit a commit:created event for" } ] }, "docs": "Replays a commit:created event." } ] }, { "info": { "name": "subpackage_data-clips", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-clips", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query" }, { "name": "sheetId", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "List" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/data-clips", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DataClip." }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ] }, "docs": "Get" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ] }, "docs": "Delete" }, { "info": { "name": "Add Records To Clip", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId/add-records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds records to an existing DataClip." }, { "info": { "name": "Get Resolutions", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId/resolutions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" }, { "name": "includeRecords", "value": "", "type": "query", "description": "Include records in the response. Default is true" }, { "name": "includeSummary", "value": "", "type": "query", "description": "Include summary in the response. Default is false" }, { "name": "filterColumn", "value": "", "type": "query", "description": "The column to filter by." }, { "name": "filterConflicts", "value": "", "type": "query", "description": "Whether to filter only conflicts. Default is false" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of resolutions to return in a page. Default is 1000" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number of resolutions to return" } ] }, "docs": "Get Resolutions" }, { "info": { "name": "Update Resolution", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId/resolutions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Resolution" }, { "info": { "name": "Get Resolution Index", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId/resolutions/index", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" }, { "name": "filterColumn", "value": "", "type": "query", "description": "The column to filter by." }, { "name": "filterConflicts", "value": "", "type": "query", "description": "Whether to filter only conflicts. Default is false" }, { "name": "id", "value": "", "type": "query", "description": "The record ID to get the index of." } ] }, "docs": "Get Resolution Index" }, { "info": { "name": "Refresh Resolutions", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/data-clips/:dataClipId/refresh-resolutions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "dataClipId", "value": "", "type": "path" } ] }, "docs": "Refresh Resolutions" } ] }, { "info": { "name": "subpackage_data-retention-policies", "type": "folder" }, "items": [ { "info": { "name": "List data retention policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-retention-policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "The associated Environment ID of the policy." } ] }, "docs": "Returns all data retention policies on an account matching a filter for environmentId" }, { "info": { "name": "Create a data retention policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/data-retention-policies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new data retention policy to the space" }, { "info": { "name": "Get a data retention policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/data-retention-policies/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of data retention policy to return" } ] }, "docs": "Returns a single data retention policy" }, { "info": { "name": "Update a data retention policy", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/data-retention-policies/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of data retention policy to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a single data retention policy" }, { "info": { "name": "Delete a data retention policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/data-retention-policies/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of data retention policy to delete" } ] }, "docs": "Deletes a single data retention policy" } ] }, { "info": { "name": "subpackage_documents", "type": "folder" }, "items": [ { "info": { "name": "List documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/documents", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" } ] }, "docs": "Returns all documents for a space" }, { "info": { "name": "Create a document", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/documents", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new document to the space" }, { "info": { "name": "Get a document", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/documents/:documentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" }, { "name": "documentId", "value": "", "type": "path", "description": "ID of document to return" } ] }, "docs": "Returns a single document" }, { "info": { "name": "Update a document", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/documents/:documentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" }, { "name": "documentId", "value": "", "type": "path", "description": "ID of document to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "updates a single document, for only the body and title" }, { "info": { "name": "Delete a document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/documents/:documentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" }, { "name": "documentId", "value": "", "type": "path", "description": "ID of document to delete" } ] }, "docs": "Deletes a single document" } ] }, { "info": { "name": "subpackage_entitlements", "type": "folder" }, "items": [ { "info": { "name": "List entitlements", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/entitlements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "resourceId", "value": "", "type": "query", "description": "The associated Resource ID for the entitlements." } ] }, "docs": "Returns all entitlements matching a filter for resourceId" } ] }, { "info": { "name": "subpackage_environments", "type": "folder" }, "items": [ { "info": { "name": "List environments", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Number of environments to return in a page (default 10)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of environments to return" } ] }, "docs": "Get all environments" }, { "info": { "name": "Create an environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/environments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new environment" }, { "info": { "name": "Get environment subscription credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments/subscription-token", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "ID of environment to return" } ] }, "docs": "Get a token which can be used to subscribe to events for this environment" }, { "info": { "name": "Get an environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments/:environmentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment to return. To fetch the current environment, pass `current`" } ] }, "docs": "Returns a single environment" }, { "info": { "name": "Update an environment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/environments/:environmentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a single environment, to change the name for example" }, { "info": { "name": "Delete an environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/environments/:environmentId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment to delete" } ] }, "docs": "Deletes a single environment" }, { "info": { "name": "List guides", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" } ] }, "docs": "Returns guides in an account" }, { "info": { "name": "Create a guide", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a guide" }, { "info": { "name": "Get a guide", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides/:guideId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" }, { "name": "guideId", "value": "", "type": "path", "description": "ID of guide" } ] }, "docs": "Returns a guide" }, { "info": { "name": "Update a guide", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides/:guideId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" }, { "name": "guideId", "value": "", "type": "path", "description": "ID of guide" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a guide" }, { "info": { "name": "Delete a guide", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides/:guideId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" }, { "name": "guideId", "value": "", "type": "path", "description": "ID of guide to delete" } ] }, "docs": "Deletes a guide" }, { "info": { "name": "Get guide version", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/environments/:environmentId/guides/:guideId/versions/:version", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "ID of the environment" }, { "name": "guideId", "value": "", "type": "path", "description": "ID of the guide" }, { "name": "version", "value": "", "type": "path", "description": "Version of the guide" } ] }, "docs": "Returns a specified version of a specific guide" } ] }, { "info": { "name": "subpackage_events", "type": "folder" }, "items": [ { "info": { "name": "List events", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/events", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "Filter by environment" }, { "name": "spaceId", "value": "", "type": "query", "description": "Filter by space" }, { "name": "domain", "value": "", "type": "query", "description": "Filter by event domain" }, { "name": "topic", "value": "", "type": "query", "description": "Filter by event topic" }, { "name": "since", "value": "", "type": "query", "description": "Filter by event timestamp" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results to return in a page (default 10)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of results to return" }, { "name": "includeAcknowledged", "value": "", "type": "query", "description": "Include acknowledged events" } ] }, "docs": "Event topics that the Flatfile Platform emits." }, { "info": { "name": "Create an event", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/events", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an event" }, { "info": { "name": "Get an event", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/events/:eventId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "eventId", "value": "", "type": "path", "description": "The event id" } ] }, "docs": "Get an event" }, { "info": { "name": "Acknowledge an event", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/events/:eventId/ack", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "eventId", "value": "", "type": "path", "description": "The event id" } ] }, "docs": "Acknowledge an event" }, { "info": { "name": "Get subscription credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/subscription", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "scope", "value": "", "type": "query", "description": "The resource ID of the event stream (space or environment id)" }, { "name": "spaceId", "value": "", "type": "query", "description": "The space ID of the event stream" } ] }, "docs": "Get a token which can be used to subscribe to events for this space" } ] }, { "info": { "name": "subpackage_files", "type": "folder" }, "items": [ { "info": { "name": "List files", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/files", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of files to return in a page (default 20)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of files to return" }, { "name": "mode", "value": "", "type": "query", "description": "The storage mode of file to fetch, defaults to \"import\"" } ] }, "docs": "List files" }, { "info": { "name": "Upload a file", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/files", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "spaceId", "type": "text", "value": "" }, { "name": "environmentId", "type": "text", "value": "" }, { "name": "mode", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" }, { "name": "actions", "type": "text", "value": "" }, { "name": "origin", "type": "text", "value": "" } ] } }, "docs": "Upload a file" }, { "info": { "name": "Get a file", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/files/:fileId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "Get a file" }, { "info": { "name": "Update a file", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/files/:fileId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path", "description": "ID of file to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a file, to change the workbook id for example" }, { "info": { "name": "Delete a file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/files/:fileId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "Delete a file" }, { "info": { "name": "Download a file", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/files/:fileId/download", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "Download a file" }, { "info": { "name": "Clone a file", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/files/:fileId/clone", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "fileId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Clone a file" }, { "info": { "name": "Detect header", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/files/detect-header", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detect header" } ] }, { "info": { "name": "subpackage_flags", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" } ] }, "docs": "Gets all flags for the workbook" }, { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new flag for the workbook" }, { "info": { "name": "Get", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags/:slug", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" }, { "name": "slug", "value": "", "type": "path", "description": "The flag slug to retrieve" } ] }, "docs": "Gets a specific flag by its slug" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags/:slug", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" }, { "name": "slug", "value": "", "type": "path", "description": "The flag slug to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing flag" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags/:slug", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" }, { "name": "slug", "value": "", "type": "path", "description": "The flag slug to delete" } ] }, "docs": "Deletes a flag" }, { "info": { "name": "Bulk Mutate", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/v1/workbooks/:workbookId/flags/bulk-mutate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "The workbook ID to manage flags for" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs bulk flag operations on records" } ] }, { "info": { "name": "subpackage_guests", "type": "folder" }, "items": [ { "info": { "name": "List guests", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/guests", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "ID of space to return" }, { "name": "email", "value": "", "type": "query", "description": "Email of guest to return" } ] }, "docs": "Returns all guests" }, { "info": { "name": "Create a guest", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/guests", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Guests are only there to upload, edit, and download files and perform their tasks in a specific Space." }, { "info": { "name": "Get a guest", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/guests/:guestId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "ID of guest to return" } ] }, "docs": "Returns a single guest" }, { "info": { "name": "Update a guest", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/guests/:guestId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "ID of guest to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a single guest, for example to change name or email" }, { "info": { "name": "Delete a guest", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/guests/:guestId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "ID of guest to return" }, { "name": "spaceId", "value": "", "type": "query", "description": "ID of space to remove guest access from. If not provided, guest will be completely deleted." } ] }, "docs": "Deletes a single guest or removes guest access from a specific space" }, { "info": { "name": "Get guest token", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/guests/:guestId/token", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "ID of guest to return" }, { "name": "spaceId", "value": "", "type": "query", "description": "ID of space to return" } ] }, "docs": "Returns a single guest token" }, { "info": { "name": "List Guest Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/guests/:guestId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "The guest id" } ] }, "docs": "Lists roles assigned to a guest." }, { "info": { "name": "Assign Role to Guest", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/guests/:guestId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "The guest id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a role to a guest." }, { "info": { "name": "Remove Role from Guest", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/guests/:guestId/roles/:actorRoleId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "guestId", "value": "", "type": "path", "description": "The guest id" }, { "name": "actorRoleId", "value": "", "type": "path", "description": "The actor role id" } ] }, "docs": "Removes a role from a guest." }, { "info": { "name": "Invite guests", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/invitations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "subpackage_jobs", "type": "folder" }, "items": [ { "info": { "name": "List jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/jobs", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "When provided, only jobs for the given environment will be returned" }, { "name": "spaceId", "value": "", "type": "query", "description": "When provided, only jobs for the given space will be returned" }, { "name": "workbookId", "value": "", "type": "query", "description": "When provided, only jobs for the given workbook will be returned" }, { "name": "fileId", "value": "", "type": "query", "description": "When provided, only jobs for the given file will be returned" }, { "name": "parentId", "value": "", "type": "query", "description": "When provided, only jobs that are parts of the given job will be returned" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of jobs to return in a page (default 20)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of jobs to return" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction - asc (ascending) or desc (descending)" }, { "name": "excludeChildJobs", "value": "", "type": "query", "description": "When true, only top-level jobs will be returned unless a parentId is specified" }, { "name": "source", "value": "", "type": "query", "description": "When provided, only jobs with the given source will be returned" } ] }, "docs": "List jobs" }, { "info": { "name": "Create a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a job" }, { "info": { "name": "Get a job", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/jobs/:jobId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The id of the job to return" } ] }, "docs": "Get a job" }, { "info": { "name": "Update a job", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/jobs/:jobId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The id of the job to patch" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a job" }, { "info": { "name": "Delete a job", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/jobs/:jobId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The id of the job to delete" } ] }, "docs": "Delete a job" }, { "info": { "name": "Execute a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/execute", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ] }, "docs": "Execute a job and return the job" }, { "info": { "name": "Get a job's execution plan", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/plan", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ] }, "docs": "Returns a single job's execution plan" }, { "info": { "name": "Replace a job's plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/plan", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a job's entire execution plan" }, { "info": { "name": "Update a job's plan", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/plan", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update one or more individual fields on a job's execution plan" }, { "info": { "name": "Acknowledge a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/ack", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Acknowledge a job and return the job" }, { "info": { "name": "Acknowledge a job outcome", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/outcome/ack", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ] }, "docs": "Acknowledge a job outcome and return the job" }, { "info": { "name": "Complete a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/complete", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Complete a job and return the job" }, { "info": { "name": "Fail a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/fail", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Fail a job and return the job" }, { "info": { "name": "Cancel a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/cancel", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel a job and return the job" }, { "info": { "name": "Retry a failed job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/retry", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ] }, "docs": "Retry a failt job and return the job" }, { "info": { "name": "Preview a mutation", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/preview-mutation", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview the results of a mutation" }, { "info": { "name": "Split a job", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/jobs/:jobId/split", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path", "description": "ID of job to return" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Split a job and return the job" } ] }, { "info": { "name": "subpackage_mapping", "type": "folder" }, "items": [ { "info": { "name": "List mapping programs", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/mapping", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Number of programs to return in a page (default 10)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of records to return" }, { "name": "createdBy", "value": "", "type": "query", "description": "Filter by creator" }, { "name": "createdAfter", "value": "", "type": "query", "description": "Filter by creation time" }, { "name": "createdBefore", "value": "", "type": "query", "description": "Filter by creation time" }, { "name": "environmentId", "value": "", "type": "query", "description": "The ID of the environment" }, { "name": "jobId", "value": "", "type": "query", "description": "A job ID to find mapping programs for" }, { "name": "familyId", "value": "", "type": "query", "description": "Filter by family" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter by namespace" }, { "name": "sourceKeys", "value": "", "type": "query", "description": "Filter by source keys" }, { "name": "destinationKeys", "value": "", "type": "query", "description": "Filter by destination keys" } ] }, "docs": "List all mapping programs" }, { "info": { "name": "Create a mapping between two schemas", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/mapping", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "The ID of the environment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of mapping rules based on two provided schemas" }, { "info": { "name": "Delete all history for the authenticated user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/mapping", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes all history for the authenticated user" }, { "info": { "name": "Get a mapping program", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/mapping/:programId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ] }, "docs": "Get a mapping program" }, { "info": { "name": "Update a mapping program", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/mapping/:programId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a mapping program" }, { "info": { "name": "Delete a mapping program", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/mapping/:programId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ] }, "docs": "Deletes a mapping program" }, { "info": { "name": "List mapping rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ] }, "docs": "List all mapping rules in a program" }, { "info": { "name": "Add mapping rules to a program", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add mapping rules to a program" }, { "info": { "name": "Update a list of mapping rules", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a list of mapping rules in a program" }, { "info": { "name": "Delete multiple mapping rules", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes multiple mapping rules from a program" }, { "info": { "name": "Get a mapping rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules/:mappingId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" }, { "name": "mappingId", "value": "", "type": "path", "description": "ID of mapping rule" } ] }, "docs": "Get a mapping rule from a program" }, { "info": { "name": "Update a mapping rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules/:mappingId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" }, { "name": "mappingId", "value": "", "type": "path", "description": "ID of mapping rule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a mapping rule in a program" }, { "info": { "name": "Delete a mapping rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/mapping/:programId/rules/:mappingId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "programId", "value": "", "type": "path", "description": "ID of the program" }, { "name": "mappingId", "value": "", "type": "path", "description": "ID of mapping rule" } ] }, "docs": "Deletes a mapping rule from a program" } ] }, { "info": { "name": "subpackage_records", "type": "folder" }, "items": [ { "info": { "name": "Get records", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "versionId", "value": "", "type": "query", "description": "Deprecated, use `commitId` instead." }, { "name": "commitId", "value": "", "type": "query" }, { "name": "sinceVersionId", "value": "", "type": "query", "description": "Deprecated, use `sinceCommitId` instead." }, { "name": "sinceCommitId", "value": "", "type": "query" }, { "name": "sortField", "value": "", "type": "query" }, { "name": "sortDirection", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "filterField", "value": "", "type": "query", "description": "Name of field by which to filter records" }, { "name": "searchValue", "value": "", "type": "query" }, { "name": "searchField", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query", "description": "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." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of records to return in a page (default 10,000)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of records to return (Note - numbers start at 1)" }, { "name": "includeCounts", "value": "", "type": "query", "description": "**DEPRECATED** Use GET /sheets/:sheetId/counts" }, { "name": "includeLength", "value": "", "type": "query", "description": "The length of the record result set, returned as counts.total" }, { "name": "includeLinks", "value": "", "type": "query", "description": "If true, linked records will be included in the results. Defaults to false." }, { "name": "includeMessages", "value": "", "type": "query", "description": "Include error messages, defaults to false." }, { "name": "fields", "value": "", "type": "query", "description": "A list of field keys to include in the response. If not provided, all fields will be included." }, { "name": "for", "value": "", "type": "query", "description": "if \"for\" is provided, the query parameters will be pulled from the event payload" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set" } ] }, "docs": "Returns records from a sheet in a workbook" }, { "info": { "name": "Insert records", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds records to a workbook sheet" }, { "info": { "name": "Update records", "type": "http" }, "http": { "method": "PUT", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates existing records in a workbook sheet" }, { "info": { "name": "Delete records", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "ids", "value": "", "type": "query", "description": "A list of record IDs to delete. Maximum of 100 allowed." } ] }, "docs": "Deletes records from a workbook sheet" }, { "info": { "name": "Get record Indices", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records/indices", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "commitId", "value": "", "type": "query" }, { "name": "sinceCommitId", "value": "", "type": "query" }, { "name": "sortField", "value": "", "type": "query" }, { "name": "sortDirection", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "filterField", "value": "", "type": "query", "description": "Name of field by which to filter records" }, { "name": "searchValue", "value": "", "type": "query" }, { "name": "searchField", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query", "description": "List of record IDs to include in the query. Limit 100." }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set" } ] }, "docs": "Returns indices of records from a sheet in a workbook" }, { "info": { "name": "Finds and replaces field values matching search criteria\n", "type": "http" }, "http": { "method": "PUT", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/find-replace", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "filter", "value": "", "type": "query" }, { "name": "filterField", "value": "", "type": "query", "description": "Name of field by which to filter records" }, { "name": "searchValue", "value": "", "type": "query" }, { "name": "searchField", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query", "description": "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" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Bulk update records with field values\n", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/records/bulk-update", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "filter", "value": "", "type": "query" }, { "name": "filterField", "value": "", "type": "query", "description": "Name of field by which to filter records" }, { "name": "searchValue", "value": "", "type": "query" }, { "name": "searchField", "value": "", "type": "query" }, { "name": "sortField", "value": "", "type": "query" }, { "name": "sortDirection", "value": "", "type": "query" }, { "name": "ids", "value": "", "type": "query", "description": "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" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set" }, { "name": "silent", "value": "", "type": "query", "description": "Whether to suppress events for this bulk update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple records at once with the same field values based on filter criteria. This is similar to a SQL UPDATE statement where you can update specific fields for all records matching certain conditions." } ] }, { "info": { "name": "subpackage_roles", "type": "folder" }, "items": [ { "info": { "name": "List roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ] }, "docs": "List all roles for an account" } ] }, { "info": { "name": "subpackage_routines", "type": "folder" }, "items": [ { "info": { "name": "List routines", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/routines", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "query" } ] }, "docs": "Returns a list of routines" }, { "info": { "name": "Create a routine", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/routines", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new routine" }, { "info": { "name": "Get a routine", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/routines/:routineId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "routineId", "value": "", "type": "path" } ] }, "docs": "Returns a routine" }, { "info": { "name": "Update a routine", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/routines/:routineId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "routineId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a routine" }, { "info": { "name": "Delete a routine", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/routines/:routineId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "routineId", "value": "", "type": "path" } ] }, "docs": "Deletes a routine" } ] }, { "info": { "name": "subpackage_runbooks", "type": "folder" }, "items": [ { "info": { "name": "List runbooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/runbooks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "appId", "value": "", "type": "query" }, { "name": "environmentId", "value": "", "type": "query" }, { "name": "spaceId", "value": "", "type": "query" } ] }, "docs": "Returns a list of runbooks" }, { "info": { "name": "Create a runbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/runbooks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new runbook" }, { "info": { "name": "Get a runbook", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/runbooks/:runbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path" } ] }, "docs": "Returns a runbook" }, { "info": { "name": "Update a runbook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/runbooks/:runbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a runbook" }, { "info": { "name": "Delete a runbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/runbooks/:runbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "runbookId", "value": "", "type": "path" } ] }, "docs": "Deletes a runbook" } ] }, { "info": { "name": "subpackage_secrets", "type": "folder" }, "items": [ { "info": { "name": "List secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/secrets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "The Environment of the secret." }, { "name": "spaceId", "value": "", "type": "query", "description": "The Space of the secret." }, { "name": "actorId", "value": "", "type": "query", "description": "The Actor of the secret." } ] }, "docs": "Fetch all secrets for a given environmentId and optionally apply space overrides" }, { "info": { "name": "Upsert a Secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/secrets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Insert or Update a Secret by name for environment or space" }, { "info": { "name": "Delete a secret by it's Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/secrets/:secretId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The ID of the secret." } ] }, "docs": "Deletes a specific Secret from the Environment or Space as is the case" } ] }, { "info": { "name": "subpackage_sheets", "type": "folder" }, "items": [ { "info": { "name": "List sheets", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "query", "description": "ID of workbook" } ] }, "docs": "Returns sheets in a workbook" }, { "info": { "name": "Get a sheet", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ] }, "docs": "Returns a sheet in a workbook" }, { "info": { "name": "Update a sheet", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Sheet" }, { "info": { "name": "Delete a sheet", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ] }, "docs": "Deletes a specific sheet from a workbook" }, { "info": { "name": "Duplicate a sheet", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/duplicate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet to duplicate" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a copy of a sheet including all its data within the same workbook" }, { "info": { "name": "Validate a sheet", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/validate", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ] }, "docs": "Trigger data hooks and validation to run on a sheet" }, { "info": { "name": "Download records as a CSV file", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/download", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "versionId", "value": "", "type": "query", "description": "Deprecated, use `sinceCommitId` instead." }, { "name": "commitId", "value": "", "type": "query", "description": "Returns records that were changed in that version in that version and only those records." }, { "name": "sinceVersionId", "value": "", "type": "query", "description": "Deprecated, use `sinceCommitId` instead." }, { "name": "sinceCommitId", "value": "", "type": "query", "description": "Returns records that were changed in that version in addition to any records from versions after that version." }, { "name": "sortField", "value": "", "type": "query", "description": "The field to sort the data on." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Sort direction - asc (ascending) or desc (descending)" }, { "name": "filter", "value": "", "type": "query", "description": "Options to filter records" }, { "name": "filterField", "value": "", "type": "query", "description": "The field to filter the data on." }, { "name": "searchValue", "value": "", "type": "query", "description": "The value to search for data on." }, { "name": "searchField", "value": "", "type": "query", "description": "The field to search for data on." }, { "name": "ids", "value": "", "type": "query", "description": "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" } ] }, "docs": "Returns records from a sheet in a workbook as a csv file" }, { "info": { "name": "Get record counts", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/counts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "versionId", "value": "", "type": "query", "description": "Returns records that were changed in that version and only those records." }, { "name": "sinceVersionId", "value": "", "type": "query", "description": "Deprecated, use `sinceCommitId` instead." }, { "name": "commitId", "value": "", "type": "query", "description": "Returns records that were changed in that version in addition to any records from versions after that version." }, { "name": "sinceCommitId", "value": "", "type": "query", "description": "Listing a commit ID here will return all records since the specified commit." }, { "name": "filter", "value": "", "type": "query", "description": "Options to filter records" }, { "name": "filterField", "value": "", "type": "query", "description": "The field to filter the data on." }, { "name": "searchValue", "value": "", "type": "query", "description": "The value to search for data on." }, { "name": "searchField", "value": "", "type": "query", "description": "The field to search for data on." }, { "name": "byField", "value": "", "type": "query", "description": "If true, the counts for each field will also be returned" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set to be counted" } ] }, "docs": "Returns counts of records from a sheet" }, { "info": { "name": "List calculations", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/calculations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "versionId", "value": "", "type": "query", "description": "Returns records that were changed in that version and only those records." }, { "name": "sinceVersionId", "value": "", "type": "query", "description": "Deprecated, use `sinceCommitId` instead." }, { "name": "commitId", "value": "", "type": "query", "description": "Returns records that were changed in that version in addition to any records from versions after that version." }, { "name": "sinceCommitId", "value": "", "type": "query", "description": "Listing a commit ID here will return all records since the specified commit." }, { "name": "filter", "value": "", "type": "query", "description": "Options to filter records" }, { "name": "filterField", "value": "", "type": "query", "description": "The field to filter the data on." }, { "name": "searchValue", "value": "", "type": "query", "description": "The value to search for data on." }, { "name": "searchField", "value": "", "type": "query", "description": "The field to search for data on." }, { "name": "byField", "value": "", "type": "query", "description": "If true, the counts for each field will also be returned" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the result set to be counted" } ] }, "docs": "Returns all calculations for a sheet" }, { "info": { "name": "Get commit versions for a sheet", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/commits", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "completed", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns the commit versions for a sheet" }, { "info": { "name": "Lock a sheet", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/lock", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ] }, "docs": "Locks a sheet" }, { "info": { "name": "Unlock a sheet", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/unlock", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" } ] }, "docs": "Removes a lock from a sheet" }, { "info": { "name": "Get record cells by field", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/sheets/:sheetId/cells", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "path", "description": "ID of sheet" }, { "name": "fieldKey", "value": "", "type": "query" }, { "name": "sortField", "value": "", "type": "query" }, { "name": "sortDirection", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "filterField", "value": "", "type": "query", "description": "Name of field by which to filter records" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of records to return in a page (default 1000 if pageNumber included)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of records to return" }, { "name": "distinct", "value": "", "type": "query", "description": "Must be set to true" }, { "name": "includeCounts", "value": "", "type": "query" }, { "name": "searchValue", "value": "", "type": "query", "description": "A value to find for a given field in a sheet. Wrap the value in \"\" for exact match" }, { "name": "q", "value": "", "type": "query", "description": "An FFQL query used to filter the records to be queried" } ] }, "docs": "Returns record cell values grouped by all fields in the sheet" } ] }, { "info": { "name": "subpackage_snapshots", "type": "folder" }, "items": [ { "info": { "name": "List snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "query", "description": "ID of sheet" }, { "name": "threadId", "value": "", "type": "query", "description": "ID of thread to filter snapshots by" } ] }, "docs": "List all snapshots of a sheet" }, { "info": { "name": "Create a snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a snapshot of a sheet" }, { "info": { "name": "Get a snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/snapshots/:snapshotId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "ID of snapshot" }, { "name": "includeSummary", "value": "", "type": "query", "description": "Whether to include a summary in the snapshot response" } ] }, "docs": "Gets a snapshot of a sheet" }, { "info": { "name": "Delete a snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/snapshots/:snapshotId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "ID of snapshot" } ] }, "docs": "Deletes a snapshot of a sheet" }, { "info": { "name": "Restore a snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/snapshots/:snapshotId/restore", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "ID of snapshot" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores a snapshot of a sheet" }, { "info": { "name": "Get records from a snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/snapshots/:snapshotId/records", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "snapshotId", "value": "", "type": "path", "description": "ID of snapshot" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of records to return in a page" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of records to return" }, { "name": "changeType", "value": "", "type": "query", "description": "Filter records by change type" } ] }, "docs": "Gets records from a snapshot of a sheet" } ] }, { "info": { "name": "subpackage_spaces", "type": "folder" }, "items": [ { "info": { "name": "List spaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "query", "description": "The ID of the environment." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of spaces to return in a page (default 10)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of records to return" }, { "name": "app", "value": "", "type": "query", "description": "Filter by appId" }, { "name": "search", "value": "", "type": "query", "description": "Search query for spaces" }, { "name": "namespace", "value": "", "type": "query", "description": "Search by namespace" }, { "name": "archived", "value": "", "type": "query", "description": "Flag to include archived spaces" }, { "name": "sortField", "value": "", "type": "query", "description": "Field to sort spaces by; requires `sortDirection` if provided." }, { "name": "sortDirection", "value": "", "type": "query", "description": "Direction of sorting; requires `sortField` if provided." }, { "name": "isCollaborative", "value": "", "type": "query", "description": "Flag for collaborative (project) spaces" }, { "name": "appId", "value": "", "type": "query", "description": "(Deprecated!) Use `app` query parameter" }, { "name": "isAppTemplate", "value": "", "type": "query", "description": "Flag for app templates" } ] }, "docs": "Returns all spaces for an account or environment" }, { "info": { "name": "Create a space", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new space based on an existing Space Config" }, { "info": { "name": "Delete spaces", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/spaces", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceIds", "value": "", "type": "query", "description": "List of ids for the spaces to be deleted" } ] }, "docs": "Delete multiple spaces by id" }, { "info": { "name": "Get a space", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to return" } ] }, "docs": "Returns a single space" }, { "info": { "name": "Update a space", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a space, to change the name for example" }, { "info": { "name": "Delete a space", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to delete" } ] }, "docs": "Delete a space" }, { "info": { "name": "Archives a space", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/archive", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to archive" } ] }, "docs": "Sets archivedAt timestamp on a space" }, { "info": { "name": "Unarchives a space", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/unarchive", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to unarchive" } ] }, "docs": "Sets archivedAt timestamp on a space to null" }, { "info": { "name": "List guidances", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/guidance", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of the space" }, { "name": "includeGuide", "value": "", "type": "query", "description": "Include the guide with the guidance, default is false" } ] }, "docs": "Lists guidances" }, { "info": { "name": "Create a new guidance", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/guidance", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of the space" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new guidance" }, { "info": { "name": "Get a guidance", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/guidance/:guidanceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of the space" }, { "name": "guidanceId", "value": "", "type": "path", "description": "ID of the guidance" }, { "name": "includeGuide", "value": "", "type": "query", "description": "Include the guide with the guidance, default is false" } ] }, "docs": "Retrieves a guidance by its id" }, { "info": { "name": "Update a guidance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/guidance/:guidanceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of the space" }, { "name": "guidanceId", "value": "", "type": "path", "description": "ID of the guidance" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a guidance with the given id" }, { "info": { "name": "Delete a guidance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/guidance/:guidanceId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of the space" }, { "name": "guidanceId", "value": "", "type": "path", "description": "ID of the guidance" } ] }, "docs": "Deletes a guidance by its id" }, { "info": { "name": "List drafts for a space", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/drafts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to list drafts for" } ] }, "docs": "Lists drafts for a space" }, { "info": { "name": "Create a draft of a space", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/drafts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to create draft of" } ] }, "docs": "Creates a draft of a space" }, { "info": { "name": "Get a draft", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/drafts/:draftSpaceId/merge", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to get draft for" }, { "name": "draftSpaceId", "value": "", "type": "path", "description": "ID of draft space to get" } ] }, "docs": "Gets a draft by the space id and draft space id" }, { "info": { "name": "Merge a draft", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/spaces/:spaceId/drafts/:draftSpaceId/merge", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "ID of space to merge draft into" }, { "name": "draftSpaceId", "value": "", "type": "path", "description": "ID of draft space to merge" } ] }, "docs": "Merges a draft into a space" } ] }, { "info": { "name": "subpackage_users", "type": "folder" }, "items": [ { "info": { "name": "List users", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/users", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "email", "value": "", "type": "query", "description": "Email of guest to return" }, { "name": "search", "value": "", "type": "query", "description": "String to search for users by name and email" }, { "name": "sortField", "value": "", "type": "query", "description": "Field to sort users by" }, { "name": "sortDirection", "value": "", "type": "query", "description": "Direction of sorting" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of users to return in a page (default 20)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of users to return" } ] }, "docs": "Gets a list of users" }, { "info": { "name": "Create and Invite User", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/users/invite", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and invites a new user to your account." }, { "info": { "name": "Resend User Invite", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/users/:userId/resend-invite", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ] }, "docs": "Resends an invite to a user for your account." }, { "info": { "name": "Get a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/users/:userId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ] }, "docs": "Gets a user" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/users/:userId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/users/:userId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ] }, "docs": "Deletes a user" }, { "info": { "name": "List User Roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/users/:userId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ] }, "docs": "Lists roles assigned to a user." }, { "info": { "name": "Assign Role to User", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/users/:userId/roles", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns a role to a user." }, { "info": { "name": "Remove Role from User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/users/:userId/roles/:actorRoleId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user id" }, { "name": "actorRoleId", "value": "", "type": "path", "description": "The actor role id" } ] }, "docs": "Removes a role from a user." } ] }, { "info": { "name": "subpackage_versions", "type": "folder" }, "items": [ { "info": { "name": "Create Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/versions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Id" } ] }, { "info": { "name": "subpackage_views", "type": "folder" }, "items": [ { "info": { "name": "List views by Sheet", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/views", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "sheetId", "value": "", "type": "query", "description": "The associated sheet ID of the view." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of prompts to return in a page (default 10)" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Based on pageSize, which page of prompts to return" } ] }, "docs": "Returns all views for the sheet" }, { "info": { "name": "Create a view", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/views", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new view to the space" }, { "info": { "name": "Get a view", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/views/:viewId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "ID of view to return" } ] }, "docs": "Returns a single view" }, { "info": { "name": "Update a view", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/views/:viewId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "ID of view to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a single view" }, { "info": { "name": "Delete a view", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/views/:viewId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "viewId", "value": "", "type": "path", "description": "ID of view to delete" } ] }, "docs": "Deletes a single view" } ] }, { "info": { "name": "subpackage_workbooks", "type": "folder" }, "items": [ { "info": { "name": "List workbooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/workbooks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "spaceId", "value": "", "type": "query", "description": "The associated Space ID of the Workbook." }, { "name": "name", "value": "", "type": "query", "description": "Filter by name. Precede with - to negate the filter" }, { "name": "namespace", "value": "", "type": "query", "description": "Filter by namespace. Precede with - to negate the filter" }, { "name": "label", "value": "", "type": "query", "description": "Filter by label. Precede with - to negate the filter" }, { "name": "treatment", "value": "", "type": "query", "description": "Filter by treatment." }, { "name": "includeSheets", "value": "", "type": "query", "description": "Include sheets for the workbook (default true)" }, { "name": "includeCounts", "value": "", "type": "query", "description": "Include counts for the workbook. **DEPRECATED** Counts will return 0s. Use GET /sheets/:sheetId/counts" } ] }, "docs": "Returns all workbooks matching a filter for an account or space" }, { "info": { "name": "Create a workbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.x.flatfile.com/v1/workbooks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a workbook and adds it to a space" }, { "info": { "name": "Get a workbook", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/workbooks/:workbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "ID of workbook to return" } ] }, "docs": "Returns a single workbook" }, { "info": { "name": "Update a workbook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.x.flatfile.com/v1/workbooks/:workbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "ID of workbook to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a workbook\n\n Adding a sheet to a workbook does not require the config object to be provided, however updating an existing sheet does.\n" }, { "info": { "name": "Delete a workbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.x.flatfile.com/v1/workbooks/:workbookId", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "ID of workbook to delete" } ] }, "docs": "Deletes a workbook and all of its record data permanently" }, { "info": { "name": "Get commits for a workbook", "type": "http" }, "http": { "method": "GET", "url": "https://api.x.flatfile.com/v1/workbooks/:workbookId/commits", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Disable-Hooks", "value": "" } ], "params": [ { "name": "workbookId", "value": "", "type": "path", "description": "ID of workbook" }, { "name": "completed", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns the commits for a workbook" } ] } ], "bundled": true }