GET
/
batch_processes
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/batch_processes \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 8,
    "status": "stopped",
    "total": 5,
    "selected_total": 5,
    "processed_count": 0,
    "failed_count": 0,
    "action_label": "referral/delete",
    "created_at": "2025-03-26T15:15:34.908Z",
    "updated_at": "2025-03-26T15:15:34.908Z",
    "meta": {},
    "progress": 0,
    "processing_errors": []
  }
]

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 processes

The response is of type object[].