Skip to main content

​
Endpoint

GET /api/v1/contacts/bulk-jobs/{jobId}/progress

​
Parameters

FieldTypeRequiredLocationDescription
jobIdUUIDyespathID of the bulk job

​
Success response 200

{
  "data": {
    "id": "job_abc123",
    "operation": "add_to_group",
    "status": "processing",
    "requestedCount": 4900,
    "processedCount": 2300,
    "progress": 47,
    "groupId": "uuid-group",
    "summary": {
      "added": 2190,
      "alreadyInGroup": 80,
      "notFound": 30
    },
    "error": null,
    "createdAt": "2026-05-08T10:00:00.000Z",
    "updatedAt": "2026-05-08T10:00:08.000Z",
    "completedAt": null
  }
}

​
Notes

  • Use this endpoint to poll every 2s
  • Stop polling when status becomes done, failed, or cancelled