Workday Benefits

opencollection: 1.0.0
info:
  name: Workday Benefits API
  version: v40.2
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://{tenant}.workday.com/ccx/oauth2/{tenant}/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Benefit Plans
    type: folder
  items:
  - info:
      name: Workday List Benefit Plans
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/benefitPlans
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
      - name: planType
        value: HEALTH
        type: query
        description: Filter by benefit plan type (HEALTH, DENTAL, VISION, LIFE, RETIREMENT)
    docs: Retrieves a collection of benefit plans including health, dental, vision, life insurance, and retirement plans available
      to employees.
  - info:
      name: Workday Get Benefit Plan
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/benefitPlans/:planId
      params:
      - name: planId
        value: BP-HEALTH-001
        type: path
        description: Benefit plan identifier
    docs: Retrieves a specific benefit plan by its identifier including coverage options and costs.
- info:
    name: Benefit Enrollments
    type: folder
  items:
  - info:
      name: Workday List Benefit Enrollments
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/benefitEnrollments
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
      - name: employeeId
        value: EMP-12345
        type: query
        description: Filter enrollments by employee ID
      - name: planId
        value: BP-HEALTH-001
        type: query
        description: Filter enrollments by benefit plan ID
    docs: Retrieves a collection of employee benefit enrollments and elections.
  - info:
      name: Workday Create Benefit Enrollment
      type: http
    http:
      method: POST
      url: https://{tenant}.workday.com/api/benefits/v1/benefitEnrollments
      body:
        type: json
        data: '{}'
    docs: Creates a new employee benefit enrollment election.
  - info:
      name: Workday Get Benefit Enrollment
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/benefitEnrollments/:enrollmentId
      params:
      - name: enrollmentId
        value: ENR-001
        type: path
        description: Benefit enrollment identifier
    docs: Retrieves a specific benefit enrollment by ID.
- info:
    name: Dependents
    type: folder
  items:
  - info:
      name: Workday List Dependents
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/dependents
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
      - name: employeeId
        value: EMP-12345
        type: query
        description: Filter dependents by employee ID
    docs: Retrieves a collection of employee dependents and beneficiaries.
  - info:
      name: Workday Create Dependent
      type: http
    http:
      method: POST
      url: https://{tenant}.workday.com/api/benefits/v1/dependents
      body:
        type: json
        data: '{}'
    docs: Creates a new employee dependent or beneficiary record.
- info:
    name: Benefit Events
    type: folder
  items:
  - info:
      name: Workday List Benefit Events
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/benefitEvents
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
      - name: employeeId
        value: EMP-12345
        type: query
        description: Filter events by employee ID
      - name: status
        value: OPEN
        type: query
        description: Filter by event status
    docs: Retrieves a collection of benefit qualifying life events and open enrollment windows.
- info:
    name: Time Off Plans
    type: folder
  items:
  - info:
      name: Workday List Time Off Plans
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/timeOffPlans
      params:
      - name: limit
        value: '100'
        type: query
        description: Maximum number of records to return
      - name: offset
        value: '0'
        type: query
        description: Number of records to skip
    docs: Retrieves a collection of time off and leave benefit plans.
- info:
    name: Employee Benefits
    type: folder
  items:
  - info:
      name: Workday Get Employee Benefits
      type: http
    http:
      method: GET
      url: https://{tenant}.workday.com/api/benefits/v1/employees/:employeeId/benefits
      params:
      - name: employeeId
        value: EMP-12345
        type: path
        description: Employee identifier
    docs: Retrieves a summary of all active benefit enrollments for a specific employee.
bundled: true