Workday Recruiting Candidates API is one of 13 APIs that Workday Recruiting publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 56 JSON Schema definitions.
Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a JSON-LD context, and 56 JSON Schemas.
This API exposes
10 operations
across 6 paths,
and defines 6 schemas.
It is described by OpenAPI 3.1.0, at version v41.2.
Requests are made against a single base URL, https://{tenant}.workday.com/ccx/api/recruiting/v41.2.
10 operations6 paths6 schemas4 GET1 PATCH4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Workday Recruiting Candidates 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.
oauth2 — OAuth 2.0 authentication. Register an API client in Workday, grant recruiting scopes, and obtain access tokens.
Paths & Operations 10
Across 6 paths, the API surfaces 10 operations — 4 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Candidates 10
Create, retrieve, and update candidate profiles including personal information, attachments, photos, and assessment data.
GET
/candidates
Workday Recruiting List Candidates
listCandidates5 params→ 200401
POST
/candidates
Workday Recruiting Create a Candidate
createCandidatebody→ 201400401
GET
/candidates/{id}
Workday Recruiting Get a Candidate
getCandidate1 param→ 200401404
PATCH
/candidates/{id}
Workday Recruiting Update a Candidate
updateCandidate1 parambody→ 200400401404
GET
/candidates/{id}/attachments
Workday Recruiting List Candidate Attachments
listCandidateAttachments1 param→ 200401404
POST
/candidates/{id}/attachments
Workday Recruiting Add a Candidate Attachment
addCandidateAttachment1 parambody→ 201400401404
GET
/candidates/{id}/photo
Workday Recruiting Get a Candidate Photo
getCandidatePhoto1 param→ 200401404
PUT
/candidates/{id}/photo
Workday Recruiting Update a Candidate Photo
updateCandidatePhoto1 parambody→ 200400401404
POST
/candidates/{id}/assess
Workday Recruiting Assess a Candidate
assessCandidate1 parambody→ 200400401404
POST
/candidates/{id}/refer
Workday Recruiting Refer a Candidate
referCandidate1 parambody→ 201400401404
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Candidate (13 properties), CandidateCreate (6 properties), CandidateAssessment (6 properties), Attachment (6 properties). Each schema is shown below with its type and property counts.
Error
object
API error response
3 properties
Attachment
object
A file attachment associated with a candidate or job application
6 properties
CandidateAssessment
object
A candidate assessment captures evaluation results from screening tools or manual review processes during the recruiting workflow.
6 properties
Candidate
object
A candidate represents an individual being considered for employment, including their personal information, contact details, source, and associated job applica…
13 properties
Reference
object
A reference to a related Workday resource
2 properties
CandidateCreate
object
Request body for creating or updating a candidate
6 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
