{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_accounts subpackage_apps API", "version": "1.0.0" }, "items": [ { "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" } ] } ], "bundled": true }