v1

latestOpenAPI 3.0.02026-07-264731126.7 KB

Show batch process

Show details of a specific batch process <Tip>HTTP Request <br/>GET https://api.firstpromoter.com/api/v2/company/batch_processes/{id}</Tip>

get/batch_processes/{id}

Path parameters

idinteger required

Batch process id

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

idinteger

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

totalinteger

selected_totalinteger

processed_countinteger

failed_countinteger

action_labelstring

created_atstring date-time

updated_atstring date-time

metaobject nullable

progressinteger

processing_errorsstring[]

Example response

{
  "id": 8,
  "status": "stopped",
  "total": 5,
  "selected_total": 5,
  "action_label": "referral/delete",
  "created_at": "2025-03-26T15:15:34.908Z",
  "updated_at": "2025-03-26T15:15:34.908Z",
  "processing_errors": []
}