Skip to main content
GET
Show progress

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

Successfully retrieved batch process progress

{key}
integer