SmartRecruiters

Read and write SmartRecruiters jobs (create, update, status), candidates and application status, and read hiring teams, offers, users and configuration.

Open requisitions from workforce planning, feed candidates in from sourcing and move hires to HRIS and onboarding.

Build a flow with SmartRecruiters Provider API documentation

Source actions

Destination actions

Data types

Validation status

Implemented · fixture tested.

Implementation is checked against provider-shaped fixtures for every action, authentication failures, rate limits, pagination and duplicate safety. Provider sandbox and authorised account validation are recorded separately when credential-backed runs are completed.

What you can map

application status

Change application status
Destination
Duplicate protected
Sets a candidate's status (and sub-status) on a job, for example IN_REVIEW, INTERVIEW or HIRED.

applications

Get application
Source
A candidate's application to one job with status, sub-status and source.

candidate properties

List candidate properties
Source
Candidate custom property definitions with type and availability.

candidates

Create candidate
Destination
Not retried automatically
Creates a candidate in the talent pool or applied to a job.
Get candidate
Source
One candidate with education, experience and assignments.
List candidates
Source
Incremental
Candidates with primary assignment and status, filterable by job, status, tag or update time.
Update candidate
Destination
Duplicate protected
Updates candidate name, email, phone, location or web links.

departments

List departments
Source
Departments configured in SmartRecruiters.

hiring processes

List hiring processes
Source
Hiring processes with their sub-statuses.

job hiring team

List job hiring team
Source
Hiring team members and roles for a job.

job properties

List job properties
Source
Job custom property definitions.

job status

Change job status
Destination
Duplicate protected
Sets a job's status, for example SOURCING, ON_HOLD, FILLED or CANCELLED.

jobs

Create job
Destination
Not retried automatically
Creates a job with classification, location, department and job ad sections.
Get job
Source
One job with classification, hiring process and properties.
List jobs
Source
Incremental
Jobs with status, posting status, department and location, optionally updated after a timestamp.
Update job
Destination
Duplicate protected
Updates title, reference number, target hiring date, department or job properties with a JSON Patch. Changes may trigger job approval.

offers

List application offers
Source
Offers for a candidate's application (read-only; offer properties with compensation are omitted).

users

List users
Source
Incremental
SmartRecruiters users with system role and status.

Authentication

SmartRecruiters API key (X-SmartToken)

Plans and access

API access is available to SmartRecruiters customers; an administrator creates API keys. API keys have full access to the company's SmartRecruiters data; use OAuth custom applications for scoped access (not supported here).

Test environment

SmartRecruiters provides sandbox companies to customers and partners on request.

Rate limits

10 requests per second for most endpoints and 8 concurrent requests (1 for GET /candidates); HTTP 429 with rate-limit headers when exceeded.

Provider events

Webhook subscriptions for job, candidate and application events. Nexra event triggers are not yet available; flows run on demand or on a schedule.

Before you build a flow

Job compensation is not written, and offer properties (which include compensation) are not returned.
Job ads, publications, positions, attachments, screening answers, onboarding status and deletes are not implemented.
Candidate property value writes are not implemented because the value shape varies by property type.
Job and candidate creates have no idempotency key; uncertain writes are not repeated automatically.