How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SmartRecruiters Candidates API

The Candidates API from SmartRecruiters — 6 operation(s) for candidates.

SmartRecruiters Candidates API is one of 12 APIs that SmartRecruiters 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 and API documentation.

This API exposes 9 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

9 operations 6 paths 9 schemas 6 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.smartrecruiters.com
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

SmartRecruiters Candidates API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-SmartToken (ApiKey). It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 2 scopes. By default, every request must be authenticated.

Paths & Operations 9

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

Candidates 9
GET
/candidates
List Candidates
listCandidates 4 params → 200400401403429
POST
/candidates
Create Candidate
createCandidate body → 201400401403409
GET
/candidates/{candidateId}
Get Candidate
getCandidate 1 param → 200401403404
PATCH
/candidates/{candidateId}
Update Candidate
updateCandidate 1 param body → 200400401403404
GET
/candidates/{candidateId}/applications
List Candidate Applications
listCandidateApplications 1 param → 200401403404
GET
/candidates/{candidateId}/messages
List Candidate Messages
listCandidateMessages 1 param → 200401403404
POST
/candidates/{candidateId}/messages
Create Candidate Message
createCandidateMessage 1 param body → 201400401403
GET
/candidates/{candidateId}/documents
List Candidate Documents
listCandidateDocuments 1 param → 200401403404
GET
/jobs/{jobId}/candidates
List Job Candidates
listJobCandidates 4 params → 200401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Candidate (13 properties), Application (8 properties), CandidateCreate (8 properties), CandidateUpdate (6 properties). Each schema is shown below with its type and property counts.

Message
object
5 properties
Application
object
8 properties
CandidateUpdate
object
6 properties
SourceDetails
object
3 properties
Document
object
6 properties
CandidateListResult
object
4 properties
CandidateCreate
object
8 properties 3 required
CandidateListResult_2
object
4 properties
Candidate
object
13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smartrecruiters-candidates-api-openapi.yml Raw ↑

Other APIs SmartRecruiters publishes across the network.

SmartRecruiters Application API
SmartRecruiters Assessment API
SmartRecruiters Interview API
SmartRecruiters Reporting API
SmartRecruiters Job Board API
SmartRecruiters Applications API
SmartRecruiters Documents API
SmartRecruiters Jobs API
SmartRecruiters Messages API
SmartRecruiters Postings API
SmartRecruiters Teams API
Where this information came from

This is an independent, third-party profile of SmartRecruiters Candidates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.