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