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…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/background_tasks/{id}

Authorization

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

Path Parameters

companyId*string
Length1 <= length
id*string
Length1 <= length

Response Body

Background task

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
type*string

The type of background task.

Value in"resolveTransfers""autoCategorizeTransactions""finapiRefreshAccountTransactions""plaidRefreshAccountTransactions""stripeRefreshAccountTransactions""stripeRefreshSubscriptions""stripeFullSync""stripeDeltaSync""hubspotRefreshSubscriptions""resolveHubSpotCategorizations""stripeResolveInvoiceMatches""addSampleData""copyCompanyToSandbox""digistore24FullSync""digistore24DeltaSync""digistore24Import""paypalSync"
status*string

The current status of the task.

Value in"open""running""failed""succeeded"
createdTime*string
Formatdate-time
finishedTime*|
Formatdate-time
error*|

Error message if the task failed.

errorDetails*|

Detailed error information if the task failed.

accountId*string|null
integrationId*string|null
visible*boolean
data*|||||array<unknown>

Type-specific payload (e.g. newTransactionCount, processedCount, totalCount).

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.

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…