Phenom Candidates API

openapi: 3.0.3
info:
  title: Phenom Talent Experience Platform Applicants Candidates API
  version: '1.0'
  description: 'Phenom platform APIs for talent acquisition and experience management: job sync, candidate management, onboarding, applications and applicants, resume/JD parsing, SCIM-based user management, candidate tags, and AI skills prediction.'
  contact:
    name: Phenom Developer Portal
    url: https://developer.phenom.com/
  termsOfService: https://www.phenom.com/terms--conditions
servers:
- url: https://api-qa.phenompro.com
  description: QA / sandbox environment (documented base host)
security:
- bearerAuth: []
tags:
- name: Candidates
  description: Add, update, delete and retrieve candidate records.
paths:
  /candidates-api/v2/candidates:
    get:
      operationId: getCandidate
      tags:
      - Candidates
      summary: Get candidate details
      description: Fetch candidate details by candidateId, email, atsId or linkedInProfileUrl.
      parameters:
      - $ref: '#/components/parameters/PhUserId'
      - name: candidateId
        in: query
        required: false
        schema:
          type: string
      - name: email
        in: query
        required: false
        schema:
          type: string
      - name: atsId
        in: query
        required: false
        schema:
          type: string
      - name: linkedInProfileUrl
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successfully fetched the candidate details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Candidate'
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Candidate:
      type: object
      properties:
        candidateId:
          type: string
          description: Unique identifier for the candidate.
        employeeId:
          type: string
          description: Employee profile ID associated with the candidate.
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        company:
          type: string
          description: Company associated with the candidate.
        linkedInProfileURL:
          type: string
    ErrorResponse:
      type: object
      description: Standard error response returned for all 4xx and 5xx responses.
      properties:
        status:
          type: integer
          description: HTTP status code of the error.
        message:
          type: string
          description: Human-readable description of the error.
  parameters:
    PhUserId:
      name: x-ph-userId
      in: header
      required: true
      schema:
        type: string
      description: Phenom user identifier context header (required on candidate/tag/applicant operations).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer token supplied in the Authorization header. Documented on every operation as `Authorization: <token>`.'