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 Dependents API

Manage employee dependents and beneficiaries

Workday Benefits Dependents 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 Dependents. 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 2 operations across 1 path, 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.

2 operations 1 paths 4 schemas 1 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 Dependents 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 2

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

Dependents 2

Manage employee dependents and beneficiaries

GET
/dependents
Workday List Dependents
listDependents 3 params → 200401403
POST
/dependents
Workday Create Dependent
createDependent body → 201400401403

Schemas 4

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

ErrorResponse
object
Standard error response
3 properties 2 required
DependentRequest
object
Request to add a new dependent or beneficiary
6 properties 5 required
Dependent
object
An employee dependent or beneficiary
7 properties 6 required
DependentsResponse
object
Paginated response containing a list of dependents
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-benefits-dependents-api-openapi.yml Raw ↑

Other APIs Workday Benefits publishes across the network.

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