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

# Get a bulk batch

> One batch and every search it spawned, in submission order. Poll this to watch a batch finish.



## OpenAPI

````yaml /openapi.json get /api/bulk/{id}
openapi: 3.1.0
info:
  title: Revcenter API
  description: >-
    Search, enrich, and activate people and companies. Two authentication
    surfaces share one host: the bearer-token API under `/v1` for
    server-to-server and agent use, and the workspace-session API under `/api`
    that the Revcenter app itself runs on.
  version: '2026-08-12'
servers:
  - url: https://api.revcenter.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search
    description: Web search, search runs, results, exports, and shareable shortlists.
  - name: People
    description: Person search, profile enrichment, and the workspace contact pool.
  - name: Companies
    description: Company search, company enrichment, and org-chart people.
  - name: Campaigns
    description: Plan, publish, and launch outbound sequences on Smartlead and HeyReach.
  - name: Account
    description: Health, usage totals, and cost events.
paths:
  /api/bulk/{id}:
    get:
      tags:
        - Search
      summary: Get a bulk batch
      description: >-
        One batch and every search it spawned, in submission order. Poll this to
        watch a batch finish.
      operationId: getBulkBatch
      parameters:
        - name: id
          in: path
          required: true
          description: The batch ID.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The batch and its searches.
          content:
            application/json:
              schema:
                type: object
                properties:
                  batch:
                    $ref: '#/components/schemas/BulkBatch'
                  scans:
                    type: array
                    items:
                      $ref: '#/components/schemas/ScanSummary'
        '401':
          $ref: '#/components/responses/AppUnauthorized'
        '404':
          $ref: '#/components/responses/AppNotFound'
      security:
        - sessionCookie: []
components:
  schemas:
    BulkBatch:
      type: object
      properties:
        id:
          type: string
          format: uuid
        mode:
          $ref: '#/components/schemas/ScanMode'
        jd_count:
          type: integer
        status:
          type: string
          enum:
            - running
            - complete
            - failed
        error:
          type:
            - string
            - 'null'
          description: >-
            Set when some or all job descriptions failed, e.g. `2/10 JDs
            failed`.
        created_at:
          type: string
          format: date-time
    ScanSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type:
            - string
            - 'null'
        status:
          $ref: '#/components/schemas/ScanStatus'
        sector:
          type:
            - string
            - 'null'
        pulled:
          type:
            - integer
            - 'null'
          description: How many results have been pulled so far.
        target_count:
          type:
            - integer
            - 'null'
        raw_input:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        closed_at:
          type:
            - string
            - 'null'
          format: date-time
        error:
          type:
            - string
            - 'null'
    ScanMode:
      type: string
      enum:
        - candidate
        - client
      default: candidate
      description: >-
        `candidate` searches for people against a role. `client` discovers
        target companies first, then their decision-makers.
    ScanStatus:
      type: string
      enum:
        - queued
        - running
        - complete
        - failed
      description: >-
        A run that produced results finishes `complete` even if a late stage
        errored — partial results are not thrown away.
    AppError:
      type: object
      description: >-
        The error shape used by every `/api` endpoint. Flatter than the `/v1`
        shape, and `code` appears only where the UI branches on it.
      properties:
        error:
          type: string
        code:
          type: string
          examples:
            - search_unavailable
  responses:
    AppUnauthorized:
      description: >-
        Not signed in, no active workspace, or the account lacks the role this
        action needs. A frozen account gets `403` with code `frozen`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            signIn:
              value:
                error: Sign in required
    AppNotFound:
      description: >-
        The record does not exist, or belongs to another workspace. The two are
        deliberately indistinguishable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppError'
          examples:
            notFound:
              value:
                error: Scan not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Revcenter API key: `Authorization: Bearer rvc_live_...`. Keys are
        scoped, rate limited per key, and metered per workspace.
    sessionCookie:
      type: apiKey
      in: cookie
      name: session
      description: >-
        A signed-in workspace session, sent as a browser cookie. Requests must
        include credentials, and act on the session's active workspace.

````