GET
/
batch_processes
/
progress
Show progress
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/batch_processes/progress \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "30": 0,
  "31": 0,
  "32": 0
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token in the Authorization header. You can find your API Key on Your FirstPromoter Dashboard. Navigate to Settings → Integrations section → Manage API Keys

Headers

​
Account-ID
string
required

Account ID. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Query Parameters

​
filters[status]

Filter by status (array or string)

Available options:
pending,
in_progress,
completed,
failed,
stopped

Response

200
application/json

Successfully retrieved batch process progress

The response is of type object.