Phenom Applications API

Combined candidate + job data for jobs a candidate has applied to.

OpenAPI Specification

phenom-applications-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Phenom Talent Experience Platform Applicants Applications 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: Applications
  description: Combined candidate + job data for jobs a candidate has applied to.
paths:
  /apply/v2/applications:
    get:
      operationId: getApplications
      tags:
      - Applications
      summary: Get applications
      description: Fetch a list of applications (candidate + job data).
      parameters:
      - name: offset
        in: query
        required: false
        schema:
          type: integer
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyResponse'
        4XX:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ApplyResponse:
      type: object
      properties:
        status:
          type: string
        statusCode:
          type: string
        statusMessage:
          type: string
        data:
          type: array
          items:
            type: object
    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>`.'