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

# One candidate from your CRM, in full

> Use for one CRM candidate in full. candidateId from listRecruiterCandidates. Own CRM only: teammate's, hidden or archived candidate returns 404.

Required scopes: `candidates:read`, `submissions:read`.



## OpenAPI

````yaml /api/openapi.json get /recruiter/candidates/{candidateId}
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /recruiter/candidates/{candidateId}:
    get:
      summary: One candidate from your CRM, in full
      description: >-
        Use for one CRM candidate in full. candidateId from
        listRecruiterCandidates. Own CRM only: teammate's, hidden or archived
        candidate returns 404.


        Required scopes: `candidates:read`, `submissions:read`.
      operationId: getRecruiterCandidate
      parameters:
        - schema:
            type: string
            minLength: 1
            description: '`candidateId` from listRecruiterCandidates row.'
          required: true
          description: '`candidateId` from listRecruiterCandidates row.'
          name: candidateId
          in: path
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  candidateId:
                    type: string
                  name:
                    type: string
                    nullable: true
                  oneLiner:
                    type: string
                    nullable: true
                  location:
                    type: string
                    nullable: true
                  linkedinUrl:
                    type: string
                    nullable: true
                  personalUrl:
                    type: string
                    nullable: true
                  githubUrl:
                    type: string
                    nullable: true
                  yearsOfExperience:
                    type: number
                    nullable: true
                  addedAt:
                    type: string
                  relationshipStatus:
                    type: string
                  tags:
                    type: array
                    items:
                      type: string
                  note:
                    type: string
                    nullable: true
                    description: Your own free-text CRM note.
                  resume:
                    type: object
                    properties:
                      onFile:
                        type: boolean
                    required:
                      - onFile
                    description: >-
                      CRM row has profile resume. File not returned;
                      `experiences` and `education` are its structured content.
                  preferences:
                    type: object
                    nullable: true
                    properties:
                      source:
                        type: string
                      updatedAt:
                        type: string
                      locations:
                        type: array
                        items:
                          type: string
                      salaryMin:
                        type: number
                        nullable: true
                      salaryMax:
                        type: number
                        nullable: true
                      ote:
                        type: number
                        nullable: true
                      workplace:
                        type: array
                        items:
                          type: string
                      roleTypes:
                        type: array
                        items:
                          type: string
                      fundingRounds:
                        type: array
                        items:
                          type: string
                      visa:
                        type: array
                        items:
                          type: string
                      visaAuthorization:
                        type: string
                        nullable: true
                      excludedIndustries:
                        type: array
                        items:
                          type: string
                      companySizes:
                        type: array
                        items:
                          type: string
                    required:
                      - source
                      - updatedAt
                      - locations
                      - salaryMin
                      - salaryMax
                      - ote
                      - workplace
                      - roleTypes
                      - fundingRounds
                      - visa
                      - visaAuthorization
                      - excludedIndustries
                      - companySizes
                    description: >-
                      What candidate wants: newest preferences you or candidate
                      typed, else newest inferred. Null when none saved.
                  experiences:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        company:
                          type: string
                        startDate:
                          type: string
                          nullable: true
                        endDate:
                          type: string
                          nullable: true
                        isCurrent:
                          type: boolean
                        location:
                          type: string
                          nullable: true
                        employmentType:
                          type: string
                          nullable: true
                        description:
                          type: string
                          nullable: true
                      required:
                        - title
                        - company
                        - startDate
                        - endDate
                        - isCurrent
                        - location
                        - employmentType
                        - description
                  education:
                    type: array
                    items:
                      type: object
                      properties:
                        school:
                          type: string
                        degree:
                          type: string
                          nullable: true
                        startDate:
                          type: string
                          nullable: true
                        endDate:
                          type: string
                          nullable: true
                      required:
                        - school
                        - degree
                        - startDate
                        - endDate
                  applications:
                    type: array
                    items:
                      type: object
                      properties:
                        roleId:
                          type: string
                        roleName:
                          type: string
                        companyName:
                          type: string
                        urls:
                          type: object
                          properties:
                            browse:
                              type: string
                            recruit:
                              type: string
                              nullable: true
                          required:
                            - browse
                            - recruit
                          description: >-
                            `browse`: role page. `recruit` always null here;
                            getRecruiterRole has live recruit link.
                        status:
                          type: string
                          description: '`WITHDRAWN` when withdrawn.'
                        currentStage:
                          type: string
                          nullable: true
                        furthestStage:
                          type: string
                          nullable: true
                        submittedAt:
                          type: string
                      required:
                        - roleId
                        - roleName
                        - companyName
                        - urls
                        - status
                        - currentStage
                        - furthestStage
                        - submittedAt
                    description: Your submissions of this candidate, newest first.
                required:
                  - id
                  - candidateId
                  - name
                  - oneLiner
                  - location
                  - linkedinUrl
                  - personalUrl
                  - githubUrl
                  - yearsOfExperience
                  - addedAt
                  - relationshipStatus
                  - tags
                  - note
                  - resume
                  - preferences
                  - experiences
                  - education
                  - applications
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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