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 Payroll Pay Groups API

Configure and manage pay groups for organizing payroll

Workday Payroll Pay Groups API is one of 21 APIs that Workday Payroll publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 138 JSON Schema definitions.

Tagged areas include Pay Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 138 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against 2 base URLs: https://api.workday.com/payroll-input/v1, https://{tenant}.workday.com/api/payroll-input/v1.

3 operations 3 paths 5 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.workday.com/payroll/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Workday Payroll Pay Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 bearer token obtained through Workday authentication.

Paths & Operations 3

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

Pay Groups 3

Configure and manage pay groups for organizing payroll

GET
/payGroups
Workday Payroll List Pay Groups
listPayGroups 2 params → 200401
GET
/payGroups/{payGroupId}
Workday Payroll Get a Pay Group
getPayGroup 1 param → 200401404
GET
/payGroups/{payGroupId}/workers
Workday Payroll List Workers in a Pay Group
listPayGroupWorkers 3 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are PayGroup (8 properties), Error (3 properties), PayGroupCollection (2 properties), WorkerRef (2 properties). Each schema is shown below with its type and property counts.

WorkerCollection
object
2 properties
WorkerRef
object
2 properties
PayGroup
object
8 properties
PayGroupCollection
object
2 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-payroll-pay-groups-api-openapi.yml Raw ↑

Other APIs Workday Payroll publishes across the network.

Workday Payroll agentDefinition API
Workday Payroll Deductions API
Workday Payroll Earnings API
Workday Payroll Input Batches API
Workday Payroll One-Time Payments API
Workday Payroll Pay Runs API
Workday Payroll Payment Elections API
Workday Payroll Payment Results API
Workday Payroll Payroll Adjustments API
Workday Payroll Payroll Calculations API
Workday Payroll Payroll Summaries API
Workday Payroll Payslips API