v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB

Users

Get bulk import job status

Retrieve the current status and results of a bulk user import job. This endpoint can be used to track the progress of both CSV uploads.

The response includes:

Overall job status
Progress statistics
Detailed error information for failed entries
Completion timestamp when finished

get/users/bulk/jobs/{jobId}

Path parameters

jobIdstring required

ID of the bulk import job to retrieve

Response

Job status retrieved successfully

jobIdstring required

Unique identifier for the bulk import job

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Current status of the job

completedAtstring date-time

Timestamp when the job completed (only present for COMPLETED or FAILED status)

Example response

{
  "jobId": "Job:019542f5-b3e7-1d02-0000-000000000006",
  "status": "PROCESSING",
  "progress": {
    "total": 5000,
    "processed": 2500,
    "successful": 2450,
    "failed": 50
  },
  "errors": [
    {
      "correlationId": "biz456"
    }
  ],
  "completedAt": "2023-08-15T14:32:00Z"
}