GET
/
batch_processes
/
{id}
Show batch process
curl --request GET \
  --url https://v2.firstpromoter.com/api/v2/company/batch_processes/{id} \
  --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

Path Parameters

​
id
integer
required

Batch process id

Response

Successfully retrieved batch process

​
id
integer
Example:

8

​
status
enum<string>
Available options:
pending,
in_progress,
completed,
failed,
stopped
Example:

"stopped"

​
total
integer
Example:

5

​
selected_total
integer
Example:

5

​
processed_count
integer
Example:

0

​
failed_count
integer
Example:

0

​
action_label
string
Example:

"referral/delete"

​
created_at
string<date-time>
Example:

"2025-03-26T15:15:34.908Z"

​
updated_at
string<date-time>
Example:

"2025-03-26T15:15:34.908Z"

​
meta
object | null
​
progress
integer
Example:

0

​
processing_errors
string[]
Example:
[]