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

ADP Workers API

Worker (employee) data access

ADP Workers API is one of 6 APIs that ADP publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Workers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a JSON-LD context, and 1 JSON Schema.

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

Requests are made against a single base URL, https://api.adp.com.

5 operations 5 paths 10 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.adp.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

ADP Workers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 5

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

Workers 5

Worker (employee) data access

GET
/hr/v2/workers
List Workers
listWorkers 4 params → 200400401403
GET
/hr/v2/workers/{aoid}
Get Worker by Aoid
getWorker 1 param → 200404
GET
/hr/v2/workers/{aoid}/work-assignments
Get Worker Work Assignments
getWorkerWorkAssignments 1 param → 200
POST
/events/hr/v1/worker.hire
Hire a New Worker
hireWorker body → 201400
POST
/events/hr/v1/worker.terminate
Terminate a Worker
terminateWorker body → 201

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are WorkAssignment (10 properties), Person (6 properties), Worker (6 properties), Address (6 properties). Each schema is shown below with its type and property counts.

Address
object
6 properties
Worker
object
ADP Worker (employee or contractor)
6 properties
WorkerResponse
object
1 property
Person
object
6 properties
WorkerTerminateEvent
object
1 property 1 required
WorkAssignment
object
10 properties
ConfirmMessage
object
2 properties
WorkersResponse
object
2 properties
EventResponse
object
1 property
WorkerHireEvent
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adp-workers-api-openapi.yml Raw ↑

Other APIs ADP publishes across the network.

ADP Embedded Payroll API
ADP Benefits Administration API
ADP Organizations API
ADP PayrollInstructions API
ADP PayrollOutputs API