> ## Documentation Index
> Fetch the complete documentation index at: https://orbisearch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk Job Status

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

Use this endpoint to check the progress of a bulk verification job. Poll it periodically after submitting a job via [POST /v1/bulk](/docs/api-reference/bulk-submit) 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.                                 |


## OpenAPI

````yaml GET /v1/bulk/{job_id}
openapi: 3.1.0
info:
  title: OrbiSearch Public API
  version: 1.0.0
  description: >-
    Email verification API for developers and agents. [Get your API key
    →](https://orbisearch.com/dashboard/api-keys)


    **Rate limiting:** requests are limited per API key (20 requests per second
    by default). Every response includes `X-RateLimit-Limit`,
    `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers describing the
    current per-key window so clients can self-throttle; `429` responses also
    include a `Retry-After` header with the suggested backoff in seconds.
  contact:
    name: Get API Key
    url: https://orbisearch.com/dashboard/api-keys
servers:
  - url: https://api.orbisearch.com
    description: OrbiSearch Public API
security:
  - ApiKeyAuth: []
paths:
  /v1/bulk/{job_id}:
    get:
      tags:
        - Public API v1
      summary: Get Bulk Job Status
      description: >-
        Check the status and progress of a bulk verification job. Returns the

        current `status` (`pending`, `in_progress`, `partial_complete_retrying`,

        `complete`, or `failed`), the number of emails processed so far, and the

        `retry_status` for any emails that initially returned `unknown` and are

        being automatically retried.


        Clients should poll this endpoint after submitting a job and treat
        results

        as final only once `status=complete`.
      operationId: get_bulk_job_status_v1_bulk__job_id__get
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJobStatusResponse'
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 20
            X-RateLimit-Remaining:
              description: Requests remaining in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 13
            X-RateLimit-Reset:
              description: Unix timestamp (seconds) at which the current window resets.
              schema:
                type: integer
                examples:
                  - 1751700000
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                detail: Email list cannot be empty
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 20
            X-RateLimit-Remaining:
              description: Requests remaining in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 13
            X-RateLimit-Reset:
              description: Unix timestamp (seconds) at which the current window resets.
              schema:
                type: integer
                examples:
                  - 1751700000
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              example:
                detail: API key required in X-API-Key header
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '404':
          description: Job not found or does not belong to this API key
          content:
            application/json:
              example:
                detail: Job not found
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 20
            X-RateLimit-Remaining:
              description: Requests remaining in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 13
            X-RateLimit-Reset:
              description: Unix timestamp (seconds) at which the current window resets.
              schema:
                type: integer
                examples:
                  - 1751700000
        '422':
          description: Invalid request parameters
          content:
            application/json:
              example:
                detail: 'Missing required query parameter: email.'
                errors:
                  - loc: query.email
                    msg: 'Missing required query parameter: email.'
                    type: missing
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          headers:
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 20
            X-RateLimit-Remaining:
              description: Requests remaining in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 13
            X-RateLimit-Reset:
              description: Unix timestamp (seconds) at which the current window resets.
              schema:
                type: integer
                examples:
                  - 1751700000
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: >-
                Seconds the client should wait before retrying. Computed from
                the remaining rate-limit window (typically 1 for the per-second
                limit, longer when the limit is exceeded by 3x or more); for
                endpoints with a daily quota, seconds until the quota resets.
              schema:
                type: integer
                examples:
                  - 1
            X-RateLimit-Limit:
              description: Maximum requests allowed in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 20
            X-RateLimit-Remaining:
              description: Requests remaining in the current per-API-key window.
              schema:
                type: integer
                examples:
                  - 13
            X-RateLimit-Reset:
              description: Unix timestamp (seconds) at which the current window resets.
              schema:
                type: integer
                examples:
                  - 1751700000
          content:
            application/json:
              example:
                detail: >-
                  Rate limit exceeded. Maximum 20 requests per second per API
                  key. Contact us to discuss higher limits.
                code: rate_limited
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BulkJobStatusResponse:
      properties:
        job_id:
          type: string
          format: uuid
          title: Job Id
          description: Unique job identifier.
          examples:
            - 123e4567-e89b-12d3-a456-426614174000
        status:
          type: string
          enum:
            - pending
            - in_progress
            - partial_complete_retrying
            - complete
            - failed
          pattern: ^[a-z_]{1,64}$
          title: Status
          description: >-
            Current job status: pending, in_progress, partial_complete_retrying,
            complete, failed.
          examples:
            - in_progress
        total_emails:
          type: integer
          title: Total Emails
          description: Total number of emails in this job.
          examples:
            - 500
        emails_processed:
          type: integer
          title: Emails Processed
          description: Number of emails processed so far.
          examples:
            - 245
        retry_status:
          type: string
          enum:
            - none
            - pending
            - partial
            - complete
          title: Retry Status
          description: 'Retry status: none, pending, partial, complete.'
          default: none
          examples:
            - none
        submitted_at:
          type: string
          format: date-time
          title: Submitted At
          description: When the job was submitted (ISO 8601 timestamp).
          examples:
            - '2024-01-15T10:30:00+00:00'
        completed_at:
          anyOf:
            - type: string
            - type: 'null'
          format: date-time
          title: Completed At
          description: >-
            When the job was completed (ISO 8601 timestamp), or null if still in
            progress.
          examples:
            - null
      type: object
      required:
        - job_id
        - status
        - total_emails
        - emails_processed
        - submitted_at
      title: BulkJobStatusResponse
      description: Status information for a bulk verification job.
      example:
        emails_processed: 245
        job_id: 123e4567-e89b-12d3-a456-426614174000
        retry_status: none
        status: in_progress
        submitted_at: '2024-01-15T10:30:00+00:00'
        total_emails: 500
    ApiErrorResponse:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable description of what went wrong.
          examples:
            - API key required in X-API-Key header
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Stable machine-readable error code, present on conditions a client
            may want to branch on (for example `rate_limited` for the per-second
            limit versus `daily_quota_exceeded` for the daily cap). Absent on
            errors that need no further disambiguation.
          examples:
            - daily_quota_exceeded
        errors:
          anyOf:
            - items:
                $ref: '#/components/schemas/ValidationErrorDetail'
              type: array
            - type: 'null'
          title: Errors
          description: >-
            Individual validation failures, one entry per invalid parameter or
            field. Present only on 422 responses; when the request has a single
            problem, `detail` carries the same message. Absent on all other
            error codes.
      type: object
      required:
        - detail
      title: ApiErrorResponse
      description: Error response body.
    ValidationErrorDetail:
      properties:
        loc:
          type: string
          title: Loc
          description: >-
            Where in the request the problem is, as a dot-separated path (e.g.
            `query.email`, `body.0`).
          examples:
            - query.email
        msg:
          type: string
          title: Msg
          description: Human-readable description of this validation error.
          examples:
            - 'Missing required query parameter: email.'
        type:
          type: string
          title: Type
          description: >-
            Machine-readable error category (e.g. `missing`, `less_than_equal`,
            `string_too_long`).
          examples:
            - missing
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationErrorDetail
      description: One request-validation failure.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: API key for authentication
      in: header
      name: X-API-Key

````