UKG Pro HCM API — Employees

naftiko: 1.0.0-alpha2
info:
  label: UKG Pro HCM API — Employees
  description: 'UKG Pro HCM API — Employees. 4 operations. Lead operation: UKG Pro HCM List Employee IDs. Self-contained Naftiko
    capability covering one Ukg business surface.'
  tags:
  - Ukg
  - Employees
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UKG_API_KEY: UKG_API_KEY
capability:
  consumes:
  - type: http
    namespace: pro-hcm-employees
    baseUri: https://service.ultipro.com
    description: UKG Pro HCM API — Employees business capability. Self-contained, no shared references.
    resources:
    - name: personnel-v2-employee-ids
      path: /personnel/v2/employee-ids
      operations:
      - name: listemployeeids
        method: GET
        description: UKG Pro HCM List Employee IDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: per_page
          in: query
          type: integer
          description: Number of results per page
        - name: page
          in: query
          type: integer
          description: Page number
    - name: personnel-v2-employees
      path: /personnel/v2/employees
      operations:
      - name: listemployees
        method: GET
        description: UKG Pro HCM List Employees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: per_page
          in: query
          type: integer
          description: Number of results per page
        - name: page
          in: query
          type: integer
          description: Page number for pagination
        - name: employeeId
          in: query
          type: string
          description: Filter by specific employee ID
    - name: personnel-v2-employees-employeeId
      path: /personnel/v2/employees/{employeeId}
      operations:
      - name: getemployee
        method: GET
        description: UKG Pro HCM Get Employee
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
    - name: personnel-v2-employees-employeeId-jobs
      path: /personnel/v2/employees/{employeeId}/jobs
      operations:
      - name: getemployeejobs
        method: GET
        description: UKG Pro HCM Get Employee Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: employeeId
          in: path
          type: string
          description: Employee identifier
          required: true
    authentication:
      type: basic
      username: '{{env.UKG_USER}}'
      password: '{{env.UKG_PASS}}'
  exposes:
  - type: rest
    namespace: pro-hcm-employees-rest
    port: 8080
    description: REST adapter for UKG Pro HCM API — Employees. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/personnel/v2/employee-ids
      name: personnel-v2-employee-ids
      description: REST surface for personnel-v2-employee-ids.
      operations:
      - method: GET
        name: listemployeeids
        description: UKG Pro HCM List Employee IDs
        call: pro-hcm-employees.listemployeeids
        with:
          per_page: rest.per_page
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personnel/v2/employees
      name: personnel-v2-employees
      description: REST surface for personnel-v2-employees.
      operations:
      - method: GET
        name: listemployees
        description: UKG Pro HCM List Employees
        call: pro-hcm-employees.listemployees
        with:
          per_page: rest.per_page
          page: rest.page
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personnel/v2/employees/{employeeid}
      name: personnel-v2-employees-employeeid
      description: REST surface for personnel-v2-employees-employeeId.
      operations:
      - method: GET
        name: getemployee
        description: UKG Pro HCM Get Employee
        call: pro-hcm-employees.getemployee
        with:
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/personnel/v2/employees/{employeeid}/jobs
      name: personnel-v2-employees-employeeid-jobs
      description: REST surface for personnel-v2-employees-employeeId-jobs.
      operations:
      - method: GET
        name: getemployeejobs
        description: UKG Pro HCM Get Employee Jobs
        call: pro-hcm-employees.getemployeejobs
        with:
          employeeId: rest.employeeId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pro-hcm-employees-mcp
    port: 9090
    transport: http
    description: MCP adapter for UKG Pro HCM API — Employees. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: ukg-pro-hcm-list-employee
      description: UKG Pro HCM List Employee IDs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-employees.listemployeeids
      with:
        per_page: tools.per_page
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-hcm-list-employees
      description: UKG Pro HCM List Employees
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-employees.listemployees
      with:
        per_page: tools.per_page
        page: tools.page
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-hcm-get-employee
      description: UKG Pro HCM Get Employee
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-employees.getemployee
      with:
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.
    - name: ukg-pro-hcm-get-employee-2
      description: UKG Pro HCM Get Employee Jobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-hcm-employees.getemployeejobs
      with:
        employeeId: tools.employeeId
      outputParameters:
      - type: object
        mapping: $.