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

Manage payroll processing runs and their lifecycle

Workday Payroll Pay Runs 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 Runs. 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 5 operations across 3 paths, and defines 7 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.

5 operations 3 paths 7 schemas 2 GET1 PATCH2 POST

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 Runs 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 5

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

Pay Runs 5

Manage payroll processing runs and their lifecycle

GET
/payRuns
Workday Payroll List Pay Runs
listPayRuns 6 params → 200400401
POST
/payRuns
Workday Payroll Create a Pay Run
createPayRun body → 201400401
GET
/payRuns/{payRunId}
Workday Payroll Get a Pay Run
getPayRun 1 param → 200401404
PATCH
/payRuns/{payRunId}
Workday Payroll Update a Pay Run
updatePayRun 1 param body → 200400401404
POST
/payRuns/{payRunId}/complete
Workday Payroll Complete a Pay Run
completePayRun 1 param → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PayRun (15 properties), CreatePayRunRequest (4 properties), Error (3 properties), UpdatePayRunRequest (2 properties). Each schema is shown below with its type and property counts.

PayPeriod
object
2 properties
PayGroupRef
object
2 properties
CreatePayRunRequest
object
4 properties 2 required
PayRunCollection
object
2 properties
Error
object
3 properties
UpdatePayRunRequest
object
2 properties
PayRun
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workday-payroll-pay-runs-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 Groups 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