Available SmartRecruiters APIs

Application API

Create candidate

X

Get candidate status

X

Get screening question for posting

X

Approvals

Get approval request by ID

X

Get comments for given approval request

X

Add comment to given approval request

X

Get pending approvals requests where you are an approver.

X

Create approval request

X

Approve the approval request by ID

X

Reject the approval request by ID

X

Partner Configuration

Load configuration for partner

X

Updates configuration for partner

X

Integration

Setting up the integration

X

Shows consent form on partner side

X

Removes integration on partner side

X

Result

Updates package result

X

Packages

Retrieves a list of packages

X

Retrieves a package by ID

X

Orders

Orders assessment package for candidate

X

Orders inline assessment package for candidate

X

Assessment orders

Retrieves all assessment orders for specified application

X

Audit

List audit events

X

Candidates

Add tags to a candidate

X

Get tags for a candidate

X

Update tags for a candidate

X

Delete tags for a candidate

X

Get onboarding status for a candidate associated with given job

X

Sets onboarding status for a candidate associated with given job

X

Search candidates

X

Create a new candidate and assign to a talent pool

X

Request consent from multiple candidates

X

Status of candidate consent

X

Candidate consent decisions

X

Get details of a candidate

X

Delete candidate

X

Update candidate personal information

X

Get list of candidate's attachments in context of given job.

X

Get candidate's attachment.

X

Delete attachment.

X

Update a candidate's status

X

Get candidate's status history for a candidate's job

X

Update a candidate's source

X

Get candidate property values for a candidate's job

X

Add/update candidate properties values

X

Get candidate screening answers for a candidate's job

X

Create a new candidate and assign to a job

X

Get details of a candidate's application to a job

X

Configuration API

Get company information

X

Get a list of available job properties

X

Create a job property

X

Get job property by ID

X

Update a job property

X

Add a job property's translations

X

Get available job property values

X

Create a job property value

X

Update a job property value

X

Add a job property value's translations

X

Archive a job property value

X

Unarchive a job property value

X

Activate a job property

X

Deactivate a job property

X

Get job property's dependents

X

Create job property dependents

X

Remove job property's dependent

X

Get dependent job property's values

X

Get job property's dependent values

X

Add job property's dependent value

X

Remove job property's dependent values relationship

X

Creates department

X

Get departments

X

Get department

X

Get list of hiring process

X

Get hiring process

X

Get a list of available offer properties

X

Get a list of available candidate properties

X

Get candidate property by ID

X

Get candidate property values

X

Create candidate property value

X

Get candidate property value by ID

X

Update candidate property value label

X

Remove candidate property value

X

List candidate source types with subtypes

X

List candidate sources

X

Get a candidate source

X

Get a candidate source by identifier.

X

Get rejection reasons

X

Get withdrawal reasons

X

Feed

Get posting by ID

X

Update posting information

X

Get a list of postings

X

Interview types

Retrieves interview types

X

Adds interview types to already existing ones

X

Removes interview type with given name

X

Interviews

Retrieves a list of interviews

X

Creates an interview

X

Retrieves an interview

X

Modifies an interview

X

Deletes an interview

X

Timeslots

Creates a timeslot

X

Retrieves a timeslot

X

Modifies a timeslot

X

Deletes a timeslot

X

Statuses

Changes a interviewer's status in given timeslot

X

Changes a candidate's status in given timeslot

X

Jobs

Positions for a job

X

Create a new position for a job

X

Get a single position

X

Update position

X

Delete position

X

Find and list job ads for a given job

X

Create a new job ad

X

Get a job ad

X

Update a job ad

X

Publishes a job ad

X

List publications for a job ad

X

Unpublish a job ad

X

Publishes a default job ad

X

Unpublishes a job from all sources

X

Find and list publications for a job

X

Get hiring team of a job with a given id.

X

Add hiring team member of a job with a given id.

X

Removes hiring team member of a job with a given id.

X

Get note of a job.

X

Update note of a job.

X

Update job headcount.

X

Search jobs

X

Create a new job

X

Get content of a job with a given id.

X

Update a job

X

Updates job

X

Updates job status

X

Job status history

X

Get latest approval request for given job

X

Job-applications

Get a job application for given job application id.

X

Messages

Shares new messages on hireloop with users, hiring teams or everyone and sends emails.

X

Delete a message

X

Fetch messages

X

Offers

Get candidate's offers

X

Get candidate's offer

X

Get latest approval request for candidate's offer

X

Search offers

X

Postings

Lists active postings published by given company

X

Get posting by posting id or UUID for given company

X

List departments for given company

X

Files

Get report file

X

Reports

Get report files

X

Generate ad-hoc report

X

Get most recent report file

X

Get report

X

Get reports

X

Reviews

Retrieves all reviews for specified candidate and job

X

Creates a review

X

Retrieves a review

X

Updates a review

X

Deletes a review

X

New-hires

Returns details for a single new hire

X

Onboarding-processes

Returns details of a single onboarding process

X

Assignments-submissions

Returns answers submitted for a single web form assignment

X

Returns metadata for the fields that belong to a single web form assignment

X

Returns list of attachments submitted for a single activity assignment

X

Assignments

Returns assignments associated with a single onboarding process

X

Users

List users of your company

X

Create a new user.

X

Get details of my user

X

Get details of a user with given id

X

Update a user

X

Send a password reset email to a user

X

Send an activation email to a user

X

Activate a user

X

Deactivate a user

X

List system roles

X

List access groups configured in your company

X

Remove user from access group

X

Assign users to access group

X

Subscriptions

Subscribe to a webhook.

X

Retrieve webhook subscriptions.

X

Retrieve single webhook subscription.

X

Delete webhook subscription.

X

Activate webhook subscription.

X

Generate secret key for a webhook subscription.

X

Retrieve subscription secret key

X

Retrieve callback request details starting from newest.

X