> ## 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 search

> Status, stage, outcome and how many profiles it read. Poll until `status` is no longer `queued` or `running` (see Async jobs). Does not use shortlist credits.

Needs scope `searches:read`.



## OpenAPI

````yaml /openapi.json get /searches/{searchId}
openapi: 3.1.0
info:
  title: Revcenter API
  version: v1
  description: Projects, searches, scored candidates and shortlists.
servers:
  - url: https://api.revcenter.ai/v1
security:
  - bearer: []
tags:
  - name: Reference
  - name: Projects
  - name: Searches
  - name: Scoring
  - name: Shortlists
  - name: Health
paths:
  /searches/{searchId}:
    get:
      tags:
        - Searches
      summary: Get a search
      description: >-
        Status, stage, outcome and how many profiles it read. Poll until
        `status` is no longer `queued` or `running` (see Async jobs). Does not
        use shortlist credits.


        Needs scope `searches:read`.
      parameters:
        - name: searchId
          in: path
          required: true
          description: A search id
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Search'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Search:
      type: object
      properties:
        id:
          type: string
        project_id:
          type: string
        status:
          type: string
          enum:
            - queued
            - running
            - stalled
            - complete
            - failed
            - stopped
        stage:
          type:
            - string
            - 'null'
        stop_reason:
          type:
            - string
            - 'null'
        outcome:
          type:
            - string
            - 'null'
          enum:
            - Shortlist ready
            - Poor yield
            - No results
            - null
        profiles_read:
          type: integer
        delivered:
          type:
            - integer
            - 'null'
        database_only:
          type: boolean
        expansion:
          type: boolean
        criteria:
          $ref: '#/components/schemas/Criteria'
        created_at:
          type: string
        closed_at:
          type:
            - string
            - 'null'
    Meta:
      type: object
      properties:
        request_id:
          type: string
    Criteria:
      type: object
      description: See the Criteria guide and GET /reference/criteria for every field.
      properties:
        title_variants:
          type: array
          items:
            type: string
        metro:
          type: string
        allowed_metros:
          type: array
          items:
            type: string
        remote_ok:
          type: boolean
        seniority:
          type: string
          enum:
            - c_suite
            - vp
            - director
            - manager
            - ic
        years_experience:
          type: object
          properties:
            min:
              type: number
            max:
              type: number
            enforcement:
              type: string
              enum:
                - hard
                - preferred
        current_industries:
          type: array
          items:
            type: string
        exclude_industries:
          type: array
          items:
            type: string
        functions:
          type: array
          items:
            type: string
        employers:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              temporal:
                type: string
                enum:
                  - current
                  - past
                  - either
              flag:
                type: string
                enum:
                  - must
                  - prefer
                  - exclude
        schools:
          type: array
          items:
            type: string
        must_have:
          type: array
          items:
            type: string
        skills:
          type: array
          items:
            type: string
        shortlist_min_score:
          type: integer
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    Error:
      description: An error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key from Settings → Usage → API (rvc_live_…).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.