Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Show progress

Show progress of batch process. <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/batch_processes/progress</Tip>

get/batch_processes/progress

Query parameters

'pending' | 'in_progress' | 'completed' | 'failed' | 'stopped'
OR
string[]

Filter by status (array or string)

Headers

Account-IDstring required

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

Response

Successfully retrieved batch process progress

object required

Example response

{
  "30": 0,
  "31": 0,
  "32": 0
}