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

# List your agency's talent-network candidates

> Use for every candidate your agency has in talent network, on or off market. Pre-flight for given people: lookupTalentNetworkCandidates. Cursor only valid with filters it came from. Other agencies' candidates never returned.

Required scopes: `talent_network:read`.



## OpenAPI

````yaml /api/openapi.json get /talent-network/candidates
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /talent-network/candidates:
    get:
      summary: List your agency's talent-network candidates
      description: >-
        Use for every candidate your agency has in talent network, on or off
        market. Pre-flight for given people: lookupTalentNetworkCandidates.
        Cursor only valid with filters it came from. Other agencies' candidates
        never returned.


        Required scopes: `talent_network:read`.
      operationId: listTalentNetworkCandidates
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: >-
              Candidates per page, 1-100, default 50. Above 100 is rejected with
              400.
          required: false
          description: >-
            Candidates per page, 1-100, default 50. Above 100 is rejected with
            400.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Previous page's nextCursor, verbatim. Only with same filters; new
              filters start new first page.
          required: false
          description: >-
            Previous page's nextCursor, verbatim. Only with same filters; new
            filters start new first page.
          name: cursor
          in: query
        - schema:
            type: string
            enum:
              - on_market
              - off_market
            description: on_market (ParaAI considering) or off_market. Omit for both.
          required: false
          description: on_market (ParaAI considering) or off_market. Omit for both.
          name: status
          in: query
        - schema:
            type: string
            pattern: ^\d+$
            description: >-
              Inclusive floor on daysRemaining, whole days, e.g. 3. Implies
              on-market.
          required: false
          description: >-
            Inclusive floor on daysRemaining, whole days, e.g. 3. Implies
            on-market.
          name: daysRemainingMin
          in: query
        - schema:
            type: string
            pattern: ^\d+$
            description: >-
              Inclusive ceiling on daysRemaining, whole days, e.g. 7. Implies
              on-market.
          required: false
          description: >-
            Inclusive ceiling on daysRemaining, whole days, e.g. 7. Implies
            on-market.
          name: daysRemainingMax
          in: query
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  candidates:
                    type: array
                    items:
                      type: object
                      properties:
                        candidateUserId:
                          type: string
                        name:
                          type: string
                        email:
                          type: string
                          nullable: true
                        linkedinUrl:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - on_market
                            - off_market
                          description: >-
                            `on_market`: ParaAI considering candidate;
                            daysRemaining counts down window. `off_market`: in
                            network, not considered.
                        daysRemaining:
                          type: integer
                          nullable: true
                        expiresAt:
                          type: string
                          nullable: true
                        directlySubmittedAt:
                          type: string
                          nullable: true
                        hasRoleSubmission:
                          type: boolean
                      required:
                        - candidateUserId
                        - name
                        - email
                        - linkedinUrl
                        - status
                        - daysRemaining
                        - expiresAt
                        - directlySubmittedAt
                        - hasRoleSubmission
                  nextCursor:
                    type: string
                required:
                  - candidates
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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