UKG Pro Workforce Management API — Employees

naftiko: 1.0.0-alpha2
info:
  label: UKG Pro Workforce Management API — Employees
  description: 'UKG Pro Workforce Management API — Employees. 1 operations. Lead operation: UKG Pro WFM List Employees. 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-wfm-employees
    baseUri: https://api.ultipro.com/workforce/v1
    description: UKG Pro Workforce Management API — Employees business capability. Self-contained, no shared references.
    resources:
    - name: v1-employees
      path: /v1/employees
      operations:
      - name: listwfmemployees
        method: GET
        description: UKG Pro WFM List Employees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return
        - name: offset
          in: query
          type: integer
          description: Number of records to skip
        - name: locationId
          in: query
          type: string
          description: Filter by work location
    authentication:
      type: bearer
      token: '{{env.UKG_API_KEY}}'
  exposes:
  - type: rest
    namespace: pro-wfm-employees-rest
    port: 8080
    description: REST adapter for UKG Pro Workforce Management API — Employees. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/employees
      name: v1-employees
      description: REST surface for v1-employees.
      operations:
      - method: GET
        name: listwfmemployees
        description: UKG Pro WFM List Employees
        call: pro-wfm-employees.listwfmemployees
        with:
          limit: rest.limit
          offset: rest.offset
          locationId: rest.locationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: pro-wfm-employees-mcp
    port: 9090
    transport: http
    description: MCP adapter for UKG Pro Workforce Management API — Employees. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: ukg-pro-wfm-list-employees
      description: UKG Pro WFM List Employees
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: pro-wfm-employees.listwfmemployees
      with:
        limit: tools.limit
        offset: tools.offset
        locationId: tools.locationId
      outputParameters:
      - type: object
        mapping: $.