Flatfile

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: C

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flatfile/refs/heads/main/apis.yml