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 Advanced Compensation Compensation Plans API

Manage compensation plans and eligibility rules

Workday Advanced Compensation Compensation Plans API is one of 8 APIs that Workday Advanced Compensation publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 18 JSON Schema definitions.

Tagged areas include Compensation Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 18 JSON Schemas.

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

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

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v41.1
Server
https://{tenant}.workday.com/api/compensation/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Workday Advanced Compensation Compensation Plans API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 2 scopes. By default, every request must be authenticated.

  • oauth2 — Workday OAuth 2.0 authentication

Paths & Operations 2

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

Compensation Plans 2

Manage compensation plans and eligibility rules

GET
/compensationPlans
Workday List Compensation Plans
listCompensationPlans 3 params → 200401403
GET
/compensationPlans/{planId}
Workday Get Compensation Plan
getCompensationPlan 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CompensationPlan (9 properties), ErrorResponse (3 properties), CompensationPlansResponse (2 properties). Each schema is shown below with its type and property counts.

CompensationPlansResponse
object
Paginated response containing compensation plans
2 properties
CompensationPlan
object
A Workday compensation plan defining structure and eligibility
9 properties
ErrorResponse
object
Workday API error response
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-advanced-compensation-compensation-plans-api-openapi.yml Raw ↑

Other APIs Workday Advanced Compensation publishes across the network.

Workday Advanced Compensation Bonus Plans API
Workday Advanced Compensation Compensation Budgets API
Workday Advanced Compensation Compensation Grades API
Workday Advanced Compensation Compensation Reviews API
Workday Advanced Compensation Employee Compensation API
Workday Advanced Compensation Merit Plans API
Workday Advanced Compensation Stock Plans API