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

Request

Base URL
https://api.firstpromoter.com/api/v2/company
Auth
HTTP bearer
TypeScript
https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api/docs/batch_processes/progress/get.ts
A function with typed inputs. Its response is checked against the schema.

'pending' | 'in_progress' | 'completed' | 'failed' | 'stopped'

string[]

Filter by status (array or string)

Account-IDstring required

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

Successfully retrieved batch process progress

object required

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

No recorded changes to this operation across all 1 revision of this API.