Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workday Benefits Benefit Enrollments API

Manage employee benefit enrollments and elections

Workday Benefits Benefit Enrollments API is one of 6 APIs that Workday Benefits publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 14 JSON Schema definitions.

Tagged areas include Benefit Enrollments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a changelog, a support channel, and 14 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version v40.2.

Requests are made against a single base URL, https://{tenant}.workday.com/api/benefits/v1.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v40.2
Base URL
https://wd2-impl-services1.workday.com/ccx/service
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Workday Benefits Benefit Enrollments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Benefit Enrollments 3

Manage employee benefit enrollments and elections

GET
/benefitEnrollments
Workday List Benefit Enrollments
listBenefitEnrollments 4 params → 200401403
POST
/benefitEnrollments
Workday Create Benefit Enrollment
createBenefitEnrollment body → 201400401403
GET
/benefitEnrollments/{enrollmentId}
Workday Get Benefit Enrollment
getBenefitEnrollment 1 param → 200401403404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are BenefitEnrollment (10 properties), BenefitEnrollmentRequest (6 properties), ErrorResponse (3 properties), BenefitEnrollmentsResponse (2 properties). Each schema is shown below with its type and property counts.

BenefitEnrollmentRequest
object
Request to create or update a benefit enrollment
6 properties 4 required
BenefitEnrollment
object
An employee benefit enrollment election
10 properties 6 required
BenefitEnrollmentsResponse
object
Paginated response containing a list of benefit enrollments
2 properties 2 required
ErrorResponse
object
Standard error response
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-benefits-benefit-enrollments-api-openapi.yml Raw ↑

Other APIs Workday Benefits publishes across the network.

Workday Benefits Benefit Events API
Workday Benefits Benefit Plans API
Workday Benefits Dependents API
Workday Benefits Employee Benefits API
Workday Benefits Time Off Plans API