Flatfile subpackage_apps API
The subpackage_apps API from Flatfile — 6 operation(s) for subpackage_apps.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flatfile-subpackage-apps-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference subpackage_accounts Subpackage Apps API
version: 1.0.0
servers:
- url: https://api.x.flatfile.com/v1
tags:
- name: subpackage_apps
paths:
/apps:
get:
operationId: list
summary: List apps
description: Returns apps in an account
tags:
- subpackage_apps
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppsResponse'
post:
operationId: create
summary: Create an app
description: Creates an app
tags:
- subpackage_apps
parameters:
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppCreate'
/apps/{appId}:
get:
operationId: get
summary: Get an app
description: Returns an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppResponse'
patch:
operationId: update
summary: Update an app
description: Updates an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_AppPatch'
delete:
operationId: delete
summary: Delete an app
description: Deletes an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of app to delete
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_SuccessResponse'
/apps/{appId}/constraints:
get:
operationId: get-constraints
summary: Get constraints
description: Returns constraints for an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: includeBuiltins
in: query
description: Whether to include built-in constraints
required: false
schema:
type: boolean
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintsResponse'
post:
operationId: create-constraint
summary: Create constraint
description: Creates a new constraint for an app
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintCreate'
/apps/{appId}/constraints/{constraintId}:
get:
operationId: get-constraint-by-id
summary: Get constraint by ID
description: Returns a specific constraint
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: constraintId
in: path
description: ID of the constraint
required: true
schema:
$ref: '#/components/schemas/type_commons_ConstraintId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintResponse'
patch:
operationId: update-constraint
summary: Update constraint
description: Updates a specific constraint
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: constraintId
in: path
description: ID of the constraint
required: true
schema:
$ref: '#/components/schemas/type_commons_ConstraintId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintUpdate'
delete:
operationId: delete-constraint
summary: Delete constraint
description: Deletes a specific constraint
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: constraintId
in: path
description: ID of the constraint
required: true
schema:
$ref: '#/components/schemas/type_commons_ConstraintId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_SuccessResponse'
/apps/{appId}/constraints/{constraintId}/versions:
get:
operationId: get-constraint-versions
summary: Get constraint versions
description: Returns the versions of a specific constraint
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: constraintId
in: path
description: ID of the constraint
required: true
schema:
$ref: '#/components/schemas/type_commons_ConstraintId'
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintVersionsResponse'
/apps/{appId}/constraints/{constraintId}/versions/{version}:
get:
operationId: get-constraint-version
summary: Get constraint version
description: Returns a specified version of a specific constraint
tags:
- subpackage_apps
parameters:
- name: appId
in: path
description: ID of the app
required: true
schema:
$ref: '#/components/schemas/type_commons_AppId'
- name: constraintId
in: path
description: ID of the constraint
required: true
schema:
$ref: '#/components/schemas/type_commons_ConstraintId'
- name: version
in: path
description: Version of the constraint
required: true
schema:
type: integer
- name: Authorization
in: header
description: Bearer authentication
required: true
schema:
type: string
- name: X-Disable-Hooks
in: header
required: true
schema:
type: string
enum:
- 'true'
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/type_apps_ConstraintVersionResponse'
components:
schemas:
type_apps_ConstraintsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_apps_ConstraintResource'
required:
- data
title: ConstraintsResponse
type_apps_ConstraintCreate:
type: object
properties:
description:
type: string
function:
type: string
options:
description: Any type
label:
type: string
validator:
type: string
appId:
$ref: '#/components/schemas/type_commons_AppId'
title: ConstraintCreate
type_apps_ConstraintResource:
type: object
properties:
id:
$ref: '#/components/schemas/type_commons_ConstraintId'
appId:
$ref: '#/components/schemas/type_commons_AppId'
validator:
type: string
description:
type: string
function:
type: string
options:
description: Any type
label:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
required:
- id
- appId
- validator
- createdAt
- updatedAt
title: ConstraintResource
type_apps_SuccessResponse:
type: object
properties:
success:
type: boolean
required:
- success
title: SuccessResponse
type_apps_AppCreate:
type: object
properties:
name:
type: string
namespace:
type: string
type:
$ref: '#/components/schemas/type_apps_AppType'
entity:
type: string
entityPlural:
type: string
icon:
type: string
metadata:
description: Any type
environmentFilters:
description: Any type
blueprint:
description: Any type
required:
- name
- namespace
- type
description: Create an app
title: AppCreate
type_apps_ConstraintVersionResource:
type: object
properties:
id:
$ref: '#/components/schemas/type_commons_ConstraintId'
appId:
$ref: '#/components/schemas/type_commons_AppId'
validator:
type: string
description:
type: string
function:
type: string
options:
description: Any type
label:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
version:
type: integer
prompt:
type: string
required:
- id
- appId
- validator
- createdAt
- updatedAt
- version
title: ConstraintVersionResource
type_apps_AppType:
type: string
enum:
- PORTAL
- PROJECTS
- MAPPING
- WORKBOOKS
- CUSTOM
title: AppType
type_commons_ConstraintId:
type: string
description: Constraint ID
title: ConstraintId
type_apps_ConstraintUpdate:
type: object
properties:
description:
type: string
function:
type: string
options:
description: Any type
label:
type: string
title: ConstraintUpdate
type_apps_App:
type: object
properties:
id:
$ref: '#/components/schemas/type_commons_AppId'
name:
type: string
namespace:
type: string
type:
$ref: '#/components/schemas/type_apps_AppType'
entity:
type: string
entityPlural:
type: string
icon:
type: string
metadata:
description: Any type
environmentFilters:
description: Any type
blueprint:
description: Any type
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
deletedAt:
type: string
format: date-time
activatedAt:
type: string
format: date-time
required:
- id
- name
- namespace
- type
- entity
- entityPlural
- metadata
- environmentFilters
- createdAt
- updatedAt
description: An app
title: App
type_apps_AppPatch:
type: object
properties:
name:
type: string
namespace:
type: string
entity:
type: string
entityPlural:
type: string
icon:
type: string
metadata:
description: Any type
environmentFilters:
description: Any type
blueprint:
description: Any type
activatedAt:
type: string
format: date-time
description: Update an app
title: AppPatch
type_commons_AppId:
type: string
description: App ID
title: AppId
type_apps_AppsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_apps_App'
required:
- data
title: AppsResponse
type_apps_AppResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_apps_App'
required:
- data
title: AppResponse
type_apps_ConstraintVersionResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_apps_ConstraintVersionResource'
required:
- data
title: ConstraintVersionResponse
type_apps_ConstraintVersionsResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/type_apps_ConstraintVersionResource'
required:
- data
title: ConstraintVersionsResponse
type_apps_ConstraintResponse:
type: object
properties:
data:
$ref: '#/components/schemas/type_apps_ConstraintResource'
required:
- data
title: ConstraintResponse
securitySchemes:
default:
type: http
scheme: bearer