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

# List every record a project's searches returned

> Every person any of a project's searches returned, expansions included, once each in the order returned: status rolled up across the searches (scored, known, not_read), the best score, which searches returned them, and the read profile when this workspace holds one. One record per person across the project (the earliest listing wins), with the same fields as list_search_records plus first_search_id (the search that listed them first) and search_ids (every search in the project that returned them). status is scored when any of the project's searches scored them, else known when this workspace already holds them, else not_read; score is the best any of the project's searches gave. For everyone across the whole workspace, use list_candidates. No contact details. Does not use credits.

Needs scope `shortlists:read`.



## OpenAPI

````yaml /openapi.json get /projects/{projectId}/records
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: Webhooks
  - name: Health
paths:
  /projects/{projectId}/records:
    get:
      tags:
        - Projects
      summary: List every record a project's searches returned
      description: >-
        Every person any of a project's searches returned, expansions included,
        once each in the order returned: status rolled up across the searches
        (scored, known, not_read), the best score, which searches returned them,
        and the read profile when this workspace holds one. One record per
        person across the project (the earliest listing wins), with the same
        fields as list_search_records plus first_search_id (the search that
        listed them first) and search_ids (every search in the project that
        returned them). status is scored when any of the project's searches
        scored them, else known when this workspace already holds them, else
        not_read; score is the best any of the project's searches gave. For
        everyone across the whole workspace, use list_candidates. No contact
        details. Does not use credits.


        Needs scope `shortlists:read`.
      operationId: list_project_records
      parameters:
        - name: projectId
          in: path
          required: true
          description: A project id
          schema:
            type: string
        - name: profile
          in: query
          required: false
          description: false to leave profiles out
          schema:
            type: string
            enum:
              - 'false'
        - name: limit
          in: query
          required: false
          description: Up to 500 per page (default 100; 50 for projects).
          schema:
            type: integer
        - name: cursor
          in: query
          required: false
          description: The `cursor` from the previous page. Omit for the first page.
          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:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProjectRecord'
                  cursor:
                    type:
                      - string
                      - 'null'
                    description: Pass as ?cursor= for the next page; null on the last.
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                data:
                  - candidate_id: 3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a99
                    status: scored
                    score: 91
                    page: 1
                    linkedin_url: https://www.linkedin.com/in/example
                    first_name: Dana
                    last_name: Whitfield
                    title: Plant Controller
                    company: Garden State Foods
                    location: Cherry Hill, NJ
                    summary: Plant controller in food manufacturing.
                    open_profile: true
                    premium: false
                    profile: null
                    first_search_id: 0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61
                    search_ids:
                      - 0b9e7d6c-5a4f-4e3d-8c2b-1a0f9e8d7c61
                      - 7d2e4f1a-0c3b-4a5d-9e8f-6b1c2d3e4f52
                cursor: null
                meta:
                  request_id: req_01JABCDEF
        '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:
  schemas:
    ProjectRecord:
      allOf:
        - $ref: '#/components/schemas/SearchRecord'
        - type: object
          description: >-
            status rolls up across the project's searches (scored beats known
            beats not_read); score is the best any of them gave.
          properties:
            first_search_id:
              type: string
              description: The search whose page listed them first.
            search_ids:
              type: array
              items:
                type: string
              description: Every search in the project that returned them, earliest first.
    Meta:
      type: object
      properties:
        request_id:
          type: string
        total:
          type: integer
          description: On lists that count everything that matched.
    SearchRecord:
      type: object
      properties:
        candidate_id:
          type:
            - string
            - 'null'
          description: >-
            The person's id in this workspace (as list_people,
            add_shortlist_members); null when this workspace has not read them.
        status:
          type: string
          enum:
            - scored
            - known
            - not_read
          description: >-
            scored: read and scored in this search. known: already in this
            workspace from another search. not_read: listed, never read.
        score:
          type:
            - integer
            - 'null'
        page:
          type: integer
          description: The result page that listed them first.
        linkedin_url:
          type:
            - string
            - 'null'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        title:
          type:
            - string
            - 'null'
        company:
          type:
            - string
            - 'null'
        location:
          type:
            - string
            - 'null'
        summary:
          type:
            - string
            - 'null'
        open_profile:
          type:
            - boolean
            - 'null'
          description: Can be messaged without a connection.
        premium:
          type:
            - boolean
            - 'null'
        profile:
          type:
            - object
            - 'null'
          description: >-
            The full read profile, as list_people gives it; null when not read.
            No contact details.
    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
  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'
  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.