Batch Processes
List in progress batch processes.
List batch processes that are in progress
HTTP Request
GET https://v2.firstpromoter.com/api/v2/company/batch_processes
GET
Authorizations
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. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
Query Parameters
Filter by status (array or string)
Available options:
pending
, in_progress
, completed
, failed
, stopped
Response
200
application/json
Successfully retrieved batch processes
The response is of type object[]
.