Workday · Capability

Workday Benefits API — Benefit Plans

Workday Benefits API — Benefit Plans. 2 operations. Lead operation: Get Benefit Plans. Self-contained Naftiko capability covering one Workday business surface.

Run with Naftiko WorkdayBenefit Plans

What You Can Do

GET
Getbenefitplans — Get Benefit Plans
/v1/benefitplans
GET
Geteligiblebenefitplans — Get Eligible Benefit Plans
/v1/workers/{id}/eligiblebenefitplans

MCP Tools

get-benefit-plans

Get Benefit Plans

read-only idempotent
get-eligible-benefit-plans

Get Eligible Benefit Plans

read-only idempotent

Capability Spec

benefits-benefit-plans.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Workday Benefits API — Benefit Plans
  description: 'Workday Benefits API — Benefit Plans. 2 operations. Lead operation: Get Benefit Plans. Self-contained Naftiko
    capability covering one Workday business surface.'
  tags:
  - Workday
  - Benefit Plans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WORKDAY_API_KEY: WORKDAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: benefits-benefit-plans
    baseUri: https://wd2-impl-services1.workday.com/ccx/api/benefits/v1/{tenant}
    description: Workday Benefits API — Benefit Plans business capability. Self-contained, no shared references.
    resources:
    - name: benefitPlans
      path: /benefitPlans
      operations:
      - name: getbenefitplans
        method: GET
        description: Get Benefit Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: workers-ID-eligibleBenefitPlans
      path: /workers/{ID}/eligibleBenefitPlans
      operations:
      - name: geteligiblebenefitplans
        method: GET
        description: Get Eligible Benefit Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WORKDAY_API_KEY}}'
  exposes:
  - type: rest
    namespace: benefits-benefit-plans-rest
    port: 8080
    description: REST adapter for Workday Benefits API — Benefit Plans. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/benefitplans
      name: benefitplans
      description: REST surface for benefitPlans.
      operations:
      - method: GET
        name: getbenefitplans
        description: Get Benefit Plans
        call: benefits-benefit-plans.getbenefitplans
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workers/{id}/eligiblebenefitplans
      name: workers-id-eligiblebenefitplans
      description: REST surface for workers-ID-eligibleBenefitPlans.
      operations:
      - method: GET
        name: geteligiblebenefitplans
        description: Get Eligible Benefit Plans
        call: benefits-benefit-plans.geteligiblebenefitplans
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: benefits-benefit-plans-mcp
    port: 9090
    transport: http
    description: MCP adapter for Workday Benefits API — Benefit Plans. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-benefit-plans
      description: Get Benefit Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: benefits-benefit-plans.getbenefitplans
      outputParameters:
      - type: object
        mapping: $.
    - name: get-eligible-benefit-plans
      description: Get Eligible Benefit Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: benefits-benefit-plans.geteligiblebenefitplans
      outputParameters:
      - type: object
        mapping: $.