> ## 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 Lookup Job Results

> Retrieve lookup results for a bulk job. Paginated; each row mirrors the /v1/email-lookup response shape.

Use this endpoint to retrieve the lookup results for a bulk job. The response contains a `results` array — one object per row processed so far — alongside paging metadata (`limit`, `offset`, `total_rows`, `total_processed`).

You can call this endpoint while the job is still `running` to retrieve partial results. The `total_processed` field tells you how many rows have been completed at the time of the call.

## Pagination

Results are paginated with `limit` and `offset` query parameters:

| Parameter | Default | Maximum | Notes                                  |
| --------- | ------- | ------- | -------------------------------------- |
| `limit`   | `50`    | `500`   | Number of rows to return in this page. |
| `offset`  | `0`     | —       | Index into the ordered result set.     |

To page through a complete job, increment `offset` by `limit` until the returned `results` array is empty (or `offset >= total_rows`).

## Per-row shape

Each entry in `results` is identical in shape to the [POST /v1/email-lookup](/docs/api-reference/email-lookup) response — same `status`, `substatus`, `email`, enrichment fields, and the echoed `first_name`, `last_name`, `domain` from your input.

| Outcome   | `status`  | `substatus`        | `email`                | `confidence` | `credits_consumed` |
| --------- | --------- | ------------------ | ---------------------- | ------------ | ------------------ |
| Found     | `safe`    | `deliverable`      | the discovered address | `0`–`100`    | `1`                |
| Not found | `unknown` | `no_address_found` | `null`                 | `null`       | `1`                |

For `not_found` rows, the enrichment fields (`email_provider`, `mx_record`, `is_*` flags, `confidence`) may be `null` or `"Unknown"` — they're populated only when a deliverable address is returned. See the [response schema](/docs/api-reference/response-schema) for field-by-field details.

## Example response

```json theme={null}
{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "total_rows": 500,
  "total_processed": 500,
  "limit": 50,
  "offset": 0,
  "results": [
    {
      "email": "jane.doe@acme.com",
      "status": "safe",
      "substatus": "deliverable",
      "explanation": "Safe to email. The mailbox exists and is deliverable.",
      "email_provider": "Google Workspace",
      "mx_record": "aspmx.l.google.com",
      "is_domain_catch_all": false,
      "is_secure_email_gateway": false,
      "is_disposable": false,
      "is_role_account": false,
      "is_free": false,
      "credits_consumed": 1,
      "first_name": "Jane",
      "last_name": "Doe",
      "domain": "acme.com",
      "confidence": 99
    },
    {
      "email": null,
      "status": "unknown",
      "substatus": "no_address_found",
      "explanation": "No deliverable address could be found for the given name at this domain.",
      "email_provider": "Unknown",
      "mx_record": null,
      "is_domain_catch_all": null,
      "is_secure_email_gateway": false,
      "is_disposable": null,
      "is_role_account": null,
      "is_free": null,
      "credits_consumed": 1,
      "first_name": "John",
      "last_name": "Smith",
      "domain": "bigcorp.io",
      "confidence": null
    }
  ]
}
```


## OpenAPI

````yaml GET /v1/bulk-lookup/{job_id}/results
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-lookup/{job_id}/results:
    get:
      tags:
        - Public API v1
      summary: Get Bulk Lookup Results
      description: >-
        Fetch results for a bulk lookup job. Paginated with `limit` (default 50,

        max 500) and `offset` (default 0). Each row mirrors the
        `/v1/email-lookup`

        response shape.


        Rows whose lookup did not converge on a deliverable address are

        returned with `status=unknown`, `substatus=no_address_found`, and

        `credits_consumed=1` — every returned row is charged.
      operationId: get_bulk_lookup_results_v1_bulk_lookup__job_id__results_get
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            title: Job Id
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
            title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkLookupResultsResponse'
          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'
        '503':
          description: Email-lookup service not configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
              example:
                detail: Email lookup is not available in this environment
          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
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BulkLookupResultsResponse:
      properties:
        job_id:
          type: string
          format: uuid
          title: Job Id
          description: Unique job identifier.
          examples:
            - 123e4567-e89b-12d3-a456-426614174000
        total_rows:
          type: integer
          title: Total Rows
          description: Total rows submitted.
          examples:
            - 500
        total_processed:
          type: integer
          title: Total Processed
          description: Rows processed so far.
          examples:
            - 500
        limit:
          type: integer
          title: Limit
          description: Page size used for this response.
          examples:
            - 50
        offset:
          type: integer
          title: Offset
          description: Row offset into the ordered result set.
          examples:
            - 0
        results:
          items:
            $ref: '#/components/schemas/EmailLookupResponse'
          type: array
          title: Results
          description: Per-row lookup results, one object per submitted tuple.
      type: object
      required:
        - job_id
        - total_rows
        - total_processed
        - limit
        - offset
        - results
      title: BulkLookupResultsResponse
      description: Paginated results for a bulk lookup job.
      example:
        job_id: 123e4567-e89b-12d3-a456-426614174000
        limit: 50
        offset: 0
        results: []
        total_processed: 500
        total_rows: 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.
    EmailLookupResponse:
      properties:
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: >-
            The deliverable email address discovered for this person at this
            domain. Null when no deliverable address could be confirmed.
          examples:
            - jane.doe@acme.com
        status:
          type: string
          enum:
            - safe
            - unknown
          pattern: ^(safe|unknown)$
          title: Status
          description: >-
            Lookup status: safe (a deliverable address was found and is in the
            email field) or unknown (no deliverable address was found, or the
            lookup timed out; the email field is null).
          examples:
            - safe
        substatus:
          anyOf:
            - type: string
              pattern: ^(deliverable|no_address_found|timeout)$
            - type: 'null'
          enum:
            - deliverable
            - no_address_found
            - timeout
          title: Substatus
          description: >-
            Specific reason for the status: deliverable (a deliverable address
            was found — only returned with status=safe), no_address_found (no
            deliverable address was found for this person at this domain — only
            returned with status=unknown), timeout (the caller's `timeout`
            parameter exhausted before the lookup completed; retry with a larger
            timeout — only returned from /v1/email-lookup, never from
            /v1/bulk-lookup, since bulk lookups have no caller-tunable timeout).
            All substatuses are billable; refunds happen only when OrbiSearch
            infrastructure cannot complete the request.
          examples:
            - deliverable
        explanation:
          type: string
          title: Explanation
          description: Plain-English explanation of the lookup result.
          examples:
            - Safe to email. The mailbox exists and is deliverable.
        email_provider:
          type: string
          title: Email Provider
          description: >-
            Email service provider of the returned address (Google Workspace,
            Microsoft Outlook, etc.).
          examples:
            - Google Workspace
        mx_record:
          anyOf:
            - type: string
            - type: 'null'
          title: Mx Record
          description: >-
            The main mail server the domain uses to receive email. Null if the
            domain has no mail server configured.
          examples:
            - aspmx.l.google.com
        is_domain_catch_all:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Domain Catch All
          description: >-
            True if the domain accepts mail for any username (catch-all). Null
            if we could not determine whether the domain is catch-all.
          examples:
            - false
        is_secure_email_gateway:
          type: boolean
          title: Is Secure Email Gateway
          description: >-
            True if the domain is protected by a secure email gateway —
            Proofpoint, Mimecast, Barracuda, or Trend Micro.
          default: false
          examples:
            - false
        is_disposable:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Disposable
          description: >-
            True if this is a temporary/disposable email service, false if not,
            null if unknown.
          examples:
            - false
        is_role_account:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Role Account
          description: >-
            True if this is a generic role-based email (info@, support@, etc.),
            false if not, null if unknown.
          examples:
            - false
        is_free:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Free
          description: >-
            True if this is from a free email provider (gmail.com, yahoo.com,
            etc.), false if not, null if unknown.
          examples:
            - false
        credits_consumed:
          type: integer
          title: Credits Consumed
          description: Credits charged for this lookup.
          examples:
            - 1
        first_name:
          type: string
          title: First Name
          description: The first name supplied in the request.
          examples:
            - Jane
        last_name:
          type: string
          title: Last Name
          description: The last name supplied in the request.
          examples:
            - Doe
        domain:
          type: string
          title: Domain
          description: The domain supplied in the request.
          examples:
            - acme.com
        confidence:
          anyOf:
            - type: integer
              maximum: 100
              minimum: 0
            - type: 'null'
          title: Confidence
          description: >-
            How certain we are in the verdict on a 0–100 scale. See
            EmailVerificationResponse.confidence for the full scale.
          examples:
            - 99
      type: object
      required:
        - status
        - explanation
        - email_provider
        - credits_consumed
        - first_name
        - last_name
        - domain
      title: EmailLookupResponse
      description: >-
        Lookup result — best deliverable email found for a (first_name,
        last_name, domain).
      example:
        confidence: 99
        credits_consumed: 1
        domain: acme.com
        email: jane.doe@acme.com
        email_provider: Google Workspace
        explanation: Safe to email. The mailbox exists and is deliverable.
        first_name: Jane
        is_disposable: false
        is_domain_catch_all: false
        is_free: false
        is_role_account: false
        is_secure_email_gateway: false
        last_name: Doe
        mx_record: aspmx.l.google.com
        status: safe
        substatus: deliverable
    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

````