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

Workable Candidates API

The Candidates API from Workable — 16 operation(s) for candidates.

Workable Candidates API is one of 33 APIs that Workable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 16 paths. It is described by OpenAPI 3.1.0, at version 3.21.0.

Requests are made against a single base URL, https://{subdomain}.workable.com/spi/v3.

18 operations 16 paths 0 schemas 5 GET11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.21.0
Server
https://{subdomain}.workable.com/spi/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Workable Candidates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Workable API token authentication using Bearer token in Authorization header. Token types include account tokens, user tokens, and API access tokens.

Paths & Operations 18

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

Candidates 18
POST
/jobs/{shortcode}/candidates
Create candidate on job
createJobCandidate 1 param → 201
GET
/candidates
List candidates
listCandidates → 200
GET
/candidates/{id}
Get candidate
getCandidate 1 param → 200
PUT
/candidates/{id}
Update candidate
updateCandidate 1 param → 200
POST
/candidates/{id}/comments
Add candidate comment
addCandidateComment 1 param → 201
POST
/candidates/{id}/copy
Copy candidate
copyCandidate 1 param → 201
POST
/candidates/{id}/disqualify
Disqualify candidate
disqualifyCandidate 1 param → 200
POST
/candidates/{id}/revert
Revert candidate disqualification
revertCandidate 1 param → 200
POST
/candidates/{id}/move
Move candidate
moveCandidate 1 param → 200
POST
/candidates/{id}/relocate
Relocate candidate
relocateCandidate 1 param → 200
POST
/candidates/{id}/ratings
Add candidate rating
addCandidateRating 1 param → 201
PUT
/candidates/{id}/ratings
Update candidate rating
updateCandidateRating 1 param → 200
POST
/candidates/{id}/tags
Add candidate tags
addCandidateTags 1 param → 201
GET
/candidates/{id}/activities
Get candidate activities
getCandidateActivities 1 param → 200
GET
/candidates/{id}/files
Get candidate files
getCandidateFiles 1 param → 200
GET
/candidates/{id}/offer
Get candidate offer
getCandidateOffer 1 param → 200
POST
/candidates/{id}/update_custom_attribute_value
Update candidate custom attribute value
updateCandidateCustomAttributeValue 1 param → 200
POST
/talent_pool/candidates
Add to talent pool
addToTalentPool → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workable-candidates-api-openapi.yml Raw ↑

Other APIs Workable publishes across the network.

Workable Jobs API
Workable Stages API
Workable Members API
Workable Recruiters API
Workable Departments API
Workable Custom Attributes API
Workable Activities API
Workable Comments API
Workable Evaluations API
Workable Offers API
Workable Assessments API
Workable Disqualification Reasons API