SaaSFlow
DevelopersAPIReferencebackground_tasks

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.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
GET
/companies/{companyId}/background_tasks/{id}

Authorization

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
Length1 <= length
id*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/background_tasks/string"
{  "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"}

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`.

List agent definitions

List the agents that can be run for this company, each with a title and a description of what it does. The `id` here is the `definitionId` you pass when starting a run. Read this first rather than hard-coding an id, since the catalogue changes as agents are added.