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

# Read recruiter-entered preferences for many candidates at once

> Use for preferences of up to 50 candidates at once; one candidate: getTalentNetworkCandidatePreferences. Reference by candidateUserId, email or linkedinUrl; candidateUserId wins, then linkedinUrl. One person can have several entries, one per owning recruiter: read all, never assume one. Always 200; branch on per-item ok. Read-only.

Required scopes: `talent_network:read`.



## OpenAPI

````yaml /api/openapi.json post /talent-network/candidates/preferences/lookup
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/preferences/lookup:
    post:
      summary: Read recruiter-entered preferences for many candidates at once
      description: >-
        Use for preferences of up to 50 candidates at once; one candidate:
        getTalentNetworkCandidatePreferences. Reference by candidateUserId,
        email or linkedinUrl; candidateUserId wins, then linkedinUrl. One person
        can have several entries, one per owning recruiter: read all, never
        assume one. Always 200; branch on per-item ok. Read-only.


        Required scopes: `talent_network:read`.
      operationId: lookupTalentNetworkCandidatePreferences
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                candidates:
                  type: array
                  items:
                    type: object
                    properties:
                      candidateUserId:
                        type: string
                        nullable: true
                        minLength: 1
                        description: >-
                          `candidateUserId` from Talent Network list or lookup
                          row.
                      email:
                        type: string
                        nullable: true
                        description: Exact candidate email, e.g. `jane@example.com`.
                      linkedinUrl:
                        type: string
                        nullable: true
                        description: >-
                          Candidate LinkedIn profile URL, e.g.
                          `https://www.linkedin.com/in/janedoe`.
                  minItems: 1
                  maxItems: 50
                  description: >-
                    1-50 references, each candidateUserId, email, or
                    linkedinUrl; more rejected with 400.
              required:
                - candidates
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                          minimum: 0
                        candidates:
                          type: array
                          items:
                            type: object
                            properties:
                              candidateUserId:
                                type: string
                              preferences:
                                type: object
                                nullable: true
                                properties:
                                  locations:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - new_york
                                        - san_francisco
                                        - south_bay_area
                                        - los_angeles
                                        - boston
                                        - seattle
                                        - texas
                                        - chicago
                                        - europe
                                        - latam
                                        - korea
                                        - canada
                                        - australia
                                        - india
                                        - uk
                                        - washington_dc
                                        - asia
                                        - denver
                                        - florida
                                        - minnesota
                                        - sacramento
                                  workplaceTypes:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - REMOTE
                                        - ON_SITE
                                        - HYBRID
                                  salaryMin:
                                    type: integer
                                    nullable: true
                                  salaryMax:
                                    type: integer
                                    nullable: true
                                  ote:
                                    type: integer
                                    nullable: true
                                  idealFundingRounds:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - PRE_SEED
                                        - SEED
                                        - SERIES_A
                                        - SERIES_B
                                        - SERIES_C
                                        - SERIES_D_PLUS
                                        - UNKNOWN
                                  visaAuthorization:
                                    type: string
                                    nullable: true
                                    enum:
                                      - NO_VISA_AUTHORIZATION_NEEDED
                                      - HAS_VISA_AUTHORIZATION
                                      - NEEDS_NEW_VISA_AUTHORIZATION
                                  roleType:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - backend_engineer
                                        - frontend_engineer
                                        - full_stack_engineer
                                        - mobile_engineer
                                        - infrastructure_devops_sre
                                        - security_engineer
                                        - >-
                                          forward_deployed_engineer_solutions_support
                                        - robotics_software_engineer
                                        - robotics_platform_engineer
                                        - sales_solutions_engineer
                                        - qa_test_engineering
                                        - blockchain_protocol_engineer
                                        - developer_relations_advocacy
                                        - founding_engineer
                                        - product_engineer
                                        - embedded_firmware_engineer
                                        - mechanical_engineer
                                        - electrical_engineer
                                        - robotics_hardware_engineer
                                        - aerospace_flight_engineer
                                        - machine_learning_engineer
                                        - robotics_ml_engineer
                                        - data_engineer
                                        - data_science_analytics
                                        - computer_vision_engineer
                                        - research_scientist_applied_research
                                        - ai_ml_researcher
                                        - research_engineer_applied_research
                                        - data_scientist_applied_scientist
                                        - machine_learning_infrastructure
                                        - machine_learning_ops_platform
                                        - research_scientist
                                        - research_engineer
                                        - ai_engineer
                                        - product_management
                                        - product_design_ux_ui
                                        - brand_visual_design
                                        - marketing_growth
                                        - growth_engineer
                                        - growth_marketing
                                        - demand_generation
                                        - performance_paid_media
                                        - lifecycle_crm_email
                                        - seo_organic_growth
                                        - marketing_ops_analytics
                                        - product_marketing
                                        - customer_marketing
                                        - content_marketing
                                        - brand_marketing
                                        - social_media_influencer
                                        - communications_pr
                                        - events_field_marketing
                                        - marketing_leadership
                                        - founding_marketer_generalist
                                        - account_executives_sales
                                        - account_management_customer_success
                                        - business_development
                                        - sales_development_rep
                                        - customer_technical_support
                                        - content_copywriting
                                        - sales_gtm_leadership
                                        - partnerships
                                        - operations_strategy
                                        - robotics_operations_engineer
                                        - revenue_operations
                                        - finance_accounting
                                        - people_talent
                                        - chief_of_staff
                                        - program_project_management
                                        - executive_assistant
                                        - data_analyst
                                        - engineering_leadership
                                        - executive_leadership
                                        - clinical_healthcare
                                        - legal_compliance_officer
                                        - legal_operations
                                        - legal_compliance
                                        - legal_partner
                                        - legal_counsel
                                        - legal_associate
                                        - legal_in_house_counsel
                                        - legal_paralegal
                                        - legal_admin
                                  excludedIndustries:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - venture_capital
                                        - logistics
                                        - real_estate
                                        - marketplace
                                        - healthcare
                                        - life_sciences
                                        - hardware
                                        - ai
                                        - gaming
                                        - fintech
                                        - finance
                                        - education
                                        - ecommerce
                                        - devtools
                                        - defense
                                        - cybersecurity
                                        - crypto
                                        - data
                                        - enterprise
                                        - financial_services
                                        - government
                                        - insurance
                                        - law
                                        - marketing
                                        - media
                                        - transportation
                                        - environment
                                        - robotics
                                        - security
                                        - construction
                                        - manufacturing
                                        - consumer
                                        - ad_tech
                                        - b2b
                                        - api_sdk
                                        - software_development
                                        - creator_economy
                                        - edtech
                                        - autonomous_vehicles
                                  companySizePreferences:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - < 10 employees
                                        - 10 - 50 employees
                                        - 50 - 200 employees
                                        - 200 - 1000 employees
                                        - '> 1000 employees'
                                required:
                                  - locations
                                  - workplaceTypes
                                  - salaryMin
                                  - salaryMax
                                  - ote
                                  - idealFundingRounds
                                  - visaAuthorization
                                  - roleType
                                  - excludedIndustries
                                  - companySizePreferences
                            required:
                              - candidateUserId
                              - preferences
                        ok:
                          type: boolean
                        status:
                          type: string
                          enum:
                            - found
                            - not_found
                          description: >-
                            `not_found`: no candidate of approved agency member
                            matches; same as nonexistent. New values may be
                            added; treat unknown as informational.
                        message:
                          type: string
                      required:
                        - index
                        - ok
                        - status
                required:
                  - results
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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