DevelopersAPIReferencebackground_tasks
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.
Authentication
Checking whether you're signed in…
Authorization<token>
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
companyId*string
Length
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…
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…