Phenom Applicants API

openapi: 3.0.3
info:
  title: Phenom Talent Experience Platform Applicants 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: Applicants
  description: Fetch applicant data, hiring status and leads for a job.
paths:
  /candidates-api/applications/v1/jobs/{jobId}/applicants:
    get:
      operationId: getApplicantsByJob
      tags:
      - Applicants
      summary: Get applicants for a job
      description: Fetch applicants for a job based on jobId.
      parameters:
      - $ref: '#/components/parameters/PhUserId'
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      - name: from
        in: query
        required: true
        schema:
          type: integer
      - name: size
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  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).
  schemas:
    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.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Bearer token supplied in the Authorization header. Documented on every operation as `Authorization: <token>`.'