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 Studio Benefits Administration API

Web service operations for benefits enrollment, plan management, coverage administration, and life events processing.

Workday Studio Benefits Administration API is one of 18 APIs that Workday Studio publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Benefits Administration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://{baseUrl}/ccx/service/{tenant}.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://{baseUrl}/ccx/service/{tenant}
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Workday Studio Benefits Administration API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

Paths & Operations 1

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

Benefits Administration 1

Web service operations for benefits enrollment, plan management, coverage administration, and life events processing.

POST
/Benefits_Administration/Get_Benefit_Plans
Workday Studio Retrieve Benefit Plans
getBenefitPlans body → 200400401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RequestCriteria (5 properties), GetBenefitPlansRequest (2 properties), BenefitPlansResponse (2 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
2 properties
BenefitPlansResponse
object
2 properties
RequestCriteria
object
Common request criteria for filtering web service results
5 properties
GetBenefitPlansRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-studio-benefits-administration-api-openapi.yml Raw ↑

Other APIs Workday Studio publishes across the network.

Workday REST API
Workday Custom Reports API
Workday Orchestrate API
Workday Studio Absence Management API
Workday Studio Compensation API
Workday Studio Financial Management API
Workday Studio Human Resources API
Workday Studio Integration Assemblies API
Workday Studio Integration Events API
Workday Studio Integration Systems API
Workday Studio Integration Templates API
Workday Studio Launch Parameters API