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

# Download the candidate database CSV

> The candidate database as CSV (up to 5,000 people, the same filters as list_candidates): every profile field, and the profile as JSON in the last column. Does not use shortlist credits.

Needs scope `shortlists:read`.



## OpenAPI

````yaml /openapi.json get /candidates.csv
openapi: 3.1.0
info:
  title: Revcenter API
  version: v1
  description: >-
    Projects, searches, scored candidates and shortlists. Generated from the
    agent API's registry.
servers:
  - url: https://api.revcenter.ai/v1
security:
  - bearer: []
tags:
  - name: Login
  - name: Account
  - name: Actions
  - name: Reference
  - name: Projects
  - name: Searches
  - name: Scoring
  - name: Shortlists
  - name: Candidates
  - name: Health
paths:
  /candidates.csv:
    get:
      tags:
        - Candidates
      summary: Download the candidate database CSV
      description: >-
        The candidate database as CSV (up to 5,000 people, the same filters as
        list_candidates): every profile field, and the profile as JSON in the
        last column. Does not use shortlist credits.


        Needs scope `shortlists:read`.
      operationId: export_candidates
      parameters:
        - name: q
          in: query
          required: false
          description: Name, title, company or headline contains this
          schema:
            type: string
        - name: project_id
          in: query
          required: false
          description: Only people a search in this project found
          schema:
            type: string
        - name: title
          in: query
          required: false
          description: Current title contains this
          schema:
            type: string
        - name: company
          in: query
          required: false
          description: Current company contains this
          schema:
            type: string
        - name: location
          in: query
          required: false
          description: Location contains this
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            X-RateLimit-Limit:
              description: >-
                Requests allowed this minute (the tighter of the key's and the
                workspace's).
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Requests left this minute.
              schema:
                type: integer
            X-RateLimit-Reset:
              description: When the minute resets, in Unix seconds.
              schema:
                type: integer
          content:
            text/csv:
              schema:
                type: string
              example: >
                Name,Title,Company,Location,Headline,School,Years of
                experience,Open to work,LinkedIn,Projects,Added,About,Full
                experience,Education,Skills,Certifications,Languages,Profile
                JSON

                Dana Whitfield,Plant Controller,Garden State Foods,"Cherry Hill,
                NJ",,Rutgers
                University,14,No,https://www.linkedin.com/in/example,"Plant
                Controller, Camden NJ",2026-10-01,,,,,,,{}
        '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'
        '409':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: 'An error: one envelope everywhere. A 429 carries Retry-After.'
      headers:
        X-RateLimit-Limit:
          description: >-
            Requests allowed this minute (the tighter of the key's and the
            workspace's).
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Requests left this minute.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: When the minute resets, in Unix seconds.
          schema:
            type: integer
        Retry-After:
          description: Seconds to wait (on 429 and 503).
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: 'Stable: every code is on the Errors page.'
            message:
              type: string
            details:
              type:
                - object
                - 'null'
              description: >-
                Structured specifics, when there are any (for example
                retry_after_seconds).
            request_id:
              type: string
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        error:
          code: search_not_found
          message: No search with that id in this workspace.
          details: null
          request_id: req_01JABCDEF
        meta:
          request_id: req_01JABCDEF
    Meta:
      type: object
      properties:
        request_id:
          type: string
        total:
          type: integer
          description: On lists that count everything that matched.
  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.