List background tasks
List background tasks for a company. Long-running work such as bank syncs, imports, and bulk edits runs asynchronously and reports progress here. Poll this after kicking off an operation that returns a task id, and read `status` to tell running from finished and failed. Tasks with `visible: false` are high-frequency webhook refreshes that the app hides from its pending indicator; skip them if you are mirroring that behaviour. Type-specific counters (processed, total, new transactions) live in `data`.
Authentication
sf_… API key in the bearerAuth field below.A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
In: header
Path Parameters
1 <= lengthResponse Body
application/json
curl -X GET "https://example.com/companies/string/background_tasks"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda", "type": "resolveTransfers", "status": "open", "createdTime": "2019-08-24T14:15:22Z", "finishedTime": "2019-08-24T14:15:22Z", "error": "string", "errorDetails": "string", "accountId": "string", "integrationId": "string", "visible": true, "data": "string" }]Download
Get a signed URL for downloading the stored document. The URL expires after 15 minutes and carries its own access, so treat it as a secret and fetch it when the user is ready to download rather than embedding it in a page that gets cached. Returns 404 if the file does not exist or belongs to another company.
Retrieve background task
Retrieve one background task by id to check whether it is still running, what it produced, or why it failed. Returns 404 if the task does not exist or belongs to another company.