Bulk Job Status

Check the status and progress of a bulk verification job. Returns emails processed, total count, job status, and retry information.

GET /v1/bulk/{job_id}

cURL

cURL

curl --request GET \
  --url 'https://api.orbisearch.com/v1/bulk/123e4567-e89b-12d3-a456-426614174000' \
  --header 'X-API-Key: YOUR_API_KEY'

200

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "in_progress",
  "total_emails": 500,
  "emails_processed": 245,
  "retry_status": "none",
  "submitted_at": "2024-01-15T10:30:00+00:00",
  "completed_at": null
}

Use this endpoint to check the progress of a bulk verification job. Poll it periodically after submitting a job via POST /v1/bulk to determine when your results are ready. The response tells you how many emails have been processed, the current job status, and the status of any automatic retries.

Job status values

Status	Meaning
pending	Job has been accepted and is queued for processing.
in_progress	Job is actively being processed. Check emails_processed for progress.
partial_complete_retrying	Initial pass is complete. Some emails returned unknown and are being automatically retried.
complete	All emails have been processed and retries have finished. Results are ready to retrieve.
failed	The job could not be completed. Contact support if this status persists.

Retry status values

Retry status	Meaning
none	No retries required or initiated.
pending	Retries have been queued but not yet started.
partial	Some retries have completed; others are still in progress.
complete	All retries have finished.

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

job_id · string · required

Response

200

application/json

Successful Response

Status information for a bulk verification job.

job_id · string<uuid> · required

Unique job identifier.

Example:

"123e4567-e89b-12d3-a456-426614174000"

status · enum<string> · required

Current job status: pending, in_progress, partial_complete_retrying, complete, failed.

Available options: pending, in_progress, partial_complete_retrying, complete, failed

Example:

"in_progress"

total_emails · integer · required

Total number of emails in this job.

Example:

100

emails_processed · integer · required

Number of emails processed so far.

Example:

45

submitted_at · string<date-time> · required

When the job was submitted (ISO 8601 timestamp).

Example:

"2024-01-15T10:30:00+00:00"

retry_status · enum<string> · default: none

Retry status: none, pending, partial, complete.

Available options: none, pending, partial, complete

Example:

"pending"

completed_at · string<date-time>

When the job was completed (ISO 8601 timestamp), or null if still in progress.

Example:

"2024-01-15T10:35:00+00:00"