Workday · Capability

Workday Payroll API — Pay Groups

Workday Payroll API — Pay Groups. 3 operations. Lead operation: Get Pay Groups. Self-contained Naftiko capability covering one Workday business surface.

Run with Naftiko WorkdayPay Groups

What You Can Do

GET
Getpaygroups — Get Pay Groups
/v1/paygroups
GET
Getpaygroupbyid — Get Pay Group by Id
/v1/paygroups/{id}
GET
Getpaygroupdetails — Get Pay Group Details
/v1/paygroups/{id}/paygroupdetails

MCP Tools

get-pay-groups

Get Pay Groups

read-only idempotent
get-pay-group-id

Get Pay Group by Id

read-only idempotent
get-pay-group-details

Get Pay Group Details

read-only idempotent

Capability Spec

payroll-pay-groups.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Workday Payroll API — Pay Groups
  description: 'Workday Payroll API — Pay Groups. 3 operations. Lead operation: Get Pay Groups. Self-contained Naftiko capability
    covering one Workday business surface.'
  tags:
  - Workday
  - Pay Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_API_KEY: WORKDAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: payroll-pay-groups
    baseUri: https://wd2-impl-services1.workday.com/ccx/api/payroll/v1/{tenant}
    description: Workday Payroll API — Pay Groups business capability. Self-contained, no shared references.
    resources:
    - name: payGroups
      path: /payGroups
      operations:
      - name: getpaygroups
        method: GET
        description: Get Pay Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroups-ID
      path: /payGroups/{ID}
      operations:
      - name: getpaygroupbyid
        method: GET
        description: Get Pay Group by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: payGroups-ID-payGroupDetails
      path: /payGroups/{ID}/payGroupDetails
      operations:
      - name: getpaygroupdetails
        method: GET
        description: Get Pay Group Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: payroll-pay-groups-rest
    port: 8080
    description: REST adapter for Workday Payroll API — Pay Groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/paygroups
      name: paygroups
      description: REST surface for payGroups.
      operations:
      - method: GET
        name: getpaygroups
        description: Get Pay Groups
        call: payroll-pay-groups.getpaygroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroups/{id}
      name: paygroups-id
      description: REST surface for payGroups-ID.
      operations:
      - method: GET
        name: getpaygroupbyid
        description: Get Pay Group by Id
        call: payroll-pay-groups.getpaygroupbyid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/paygroups/{id}/paygroupdetails
      name: paygroups-id-paygroupdetails
      description: REST surface for payGroups-ID-payGroupDetails.
      operations:
      - method: GET
        name: getpaygroupdetails
        description: Get Pay Group Details
        call: payroll-pay-groups.getpaygroupdetails
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: payroll-pay-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Payroll API — Pay Groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-pay-groups
      description: Get Pay Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroups
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pay-group-id
      description: Get Pay Group by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pay-group-details
      description: Get Pay Group Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: payroll-pay-groups.getpaygroupdetails
      outputParameters:
      - type: object
        mapping: $.