Action

Description

Required scopes

Get Application Configuration For Posting

Get application configuration including screening questions and privacy policies

Create Candidate Application

Create a new candidate application for a job posting

Get Application Status

Get the current status of a candidate's application for a job posting

Get Job Application

Get a job application by its ID

Delete Job Application

Delete a job application by its ID

List Pending Approvals

Get all pending approval requests for the authenticated user

Get Approval Request

Get an approval request by its ID

Create Approval Request

Create a new approval request based on an existing approval

Approve Approval Request

Approve an approval request by its ID

Reject Approval Request

Reject an approval request by its ID

List Approval Comments

Get all comments for an approval request

Add Approval Comment

Add a comment to an approval request

Search Candidates

Search for candidates in SmartRecruiters with optional filters

Get Candidate

Get detailed information about a specific candidate

Create Candidate

Create a new candidate and assign to a Talent Pool

Update Candidate

Update personal information for an existing candidate

Delete Candidate

Delete a candidate from SmartRecruiters

Get Candidate Tags

Retrieve all tags assigned to a candidate

Add Candidate Tags

Add new tags to a candidate without replacing existing tags

Update Candidate Tags

Replace all tags for a candidate with a new set of tags

Delete Candidate Tags

Remove all tags from a candidate

Get Candidate Onboarding Status

Get onboarding status for a candidate (deprecated - use job-specific endpoint)

Get Candidate Onboarding Status For Job

Get onboarding status for a candidate in context of a specific job

Update Candidate Onboarding Status For Job

Set onboarding status for a candidate in context of a specific job

List Candidate Attachments

Retrieve all attachments for a candidate

Get Candidate Attachment

Retrieve a specific attachment by its unique ID

List Candidate Attachments For Job

Retrieve all attachments for a candidate's job application

Upload Candidate Attachment For Job

Upload a file attachment to a candidate in the context of a specific job application. The file must be provided as base6...

Delete Candidate Attachment

Delete a specific attachment by its unique ID

Get Candidate Status

Get public-facing application status for a candidate

Update Candidate Status

Update a candidate's status for a specific job application

Get Candidate Status History For Job

Get status history for a candidate's specific job application

Get Candidate Properties For Job

Get property values for a candidate's job application

Get Candidate Consent Status

Get consent status for a candidate

Get Candidate Consent Decisions

Get consent decisions for a candidate

Update Candidate Source

Update the source information for a candidate

Get Candidate Screening Answers

Get screening question answers for a candidate

Create A New Candidate And Assign To A Job

Create a new candidate and assign to a job

Get Candidate Application

Get details of a candidate's job application

Delete Candidate Application

Delete a candidate's job application

Parse Resume

Parse a resume file and extract structured candidate data. The file must be provided as base64 encoded content — do not...

List Access Groups

List access groups configured in your company

Get Access Group

Get details of a specific access group

Create Access Group

Create a new access group with given properties and criteria

Update Access Group

Update an existing access group

Get Company Information

Get all information about your company

List Job Properties

Get a list of all available job properties

Create Job Property

Create a new job property

Get Job Property

Get details of a specific job property

Get Job Property Values

Get available values for a job property

Create Job Property Value

Create a new value for a job property

Archive Job Property Value

Archive a job property value

Activate Job Property

Activate a job property

Get Job Property Dependents

Get dependent properties for a job property

Create Job Property Dependents

Create dependencies between job properties

Get Job Property Dependent Values

Get values for a dependent job property

Get Job Property Value Dependents

Get dependent values for a specific job property value

Add Job Property Dependent Value

Add a dependent value for a specific job property value

List Departments

Get all departments configured in the company

Get Department

Get a department by its ID

Create Department

Create a new department

List Hiring Processes

Get all hiring processes configured in the company

Get Hiring Process

Get a hiring process by its ID

List Offer Properties

Get all available offer properties

List Candidate Properties

Get all available candidate properties

Get Candidate Property

Get a candidate property by its ID

Get Candidate Property Values

Get available values for a candidate property

Create Candidate Property Value

Create a new value for a SINGLE\_SELECT candidate property

Update Candidate Property Value Label

Update the label of a candidate property value

Get Candidate Property Value

Get a specific candidate property value by ID

Get Source Types

Get all available candidate source types with subtypes

Get Source Values

Get all source values for a specific source type

Get Source Value

Get a specific candidate source by ID

Get Source By Identifier

Get a candidate source by its unique identifier

List Rejection Reasons

Get all available rejection reasons

List Withdrawal Reasons

Get all available withdrawal reasons

List Career Sites

Get all career sites configurations

Get Career Site

Get details of a specific career site configuration

List Predefined Locations

Get all predefined locations configured in the company

Create Predefined Location

Create a new predefined location

Get Predefined Location

Get a predefined location by its ID

Update Predefined Location

Update an existing predefined location

Delete Predefined Location

Delete a predefined location

Get Managed Hiring Process Steps

Get managed hiring process steps for a job

Get Interview Template

Get interview template by ID

Update Interview Template

Update an interview template

Delete Interview Template

Delete an interview template

List Interview Templates

Get interview templates for the current company

Create Interview Template

Create a new interview template

Get Job Interview Templates

Find job-level interview templates for a job

List Job Interview Templates

Find all job-level interview templates for a job

Get Application Interview Templates

Find job-level interview templates by job application ID

Search Job Interview Templates

Find job-level interview templates by job and application IDs

Update Job Interview Template

Update a job-level interview template

Save Job Interview Template

Save or replace job-level interview template for a hiring stage and step

Patch Job Interview Template Interviewers

Update interviewers pool for a job-level interview template

Get User Schedule Preferences

Find schedule preferences for a user

Get Interview Types

Get available interview types in SmartRecruiters

List Interviews

Get a list of interviews in SmartRecruiters

Get Interview

Get a specific interview by its ID

Create Interview

Create a new interview for a candidate application

Update Interview

Modify an existing interview

Delete Interview

Delete an existing interview

Update Interviewer Status

Change an interviewer's status in a given timeslot

Update Timeslot Candidate Status

Change a candidate's status in a given timeslot

Create Timeslot

Add a new timeslot to an existing interview

Get Timeslot

Retrieve a specific timeslot from an interview

Update Timeslot

Modify an existing timeslot in an interview

Delete Timeslot

Delete a timeslot from an interview

Update Timeslot No-Show

Change the no-show value for a timeslot

Delete Interview Type

Remove an interview type with the given name

Search Jobs

Search for jobs in SmartRecruiters with optional filters

Get Job

Get detailed information about a specific job

Create Job

Create a new job in SmartRecruiters

Update Job

Fully update a job with all fields including location, compensation, and properties

Update Job Status

Update the status of a job

Get Job Status History

Get the status change history for a job

Get Job Approvals

Get the latest approval request for a job

List Job Positions

List all positions for a job

Get Job Position

Get details of a specific position

Create Job Position

Create a new position for a job

Update Job Position

Update an existing position

Delete Job Position

Delete a position from a job

List Job Ads

List all job advertisements for a job

Get Job Ad

Get details of a specific job ad

Create Job Ad

Create a new job advertisement

Update Job Ad

Update an existing job advertisement

List Job Ad Postings

List all publications for a job ad

Publish Job Ad

Publish a job ad to internal sources and job aggregators

Unpublish Job Ad

Unpublish a job ad from all distribution channels

List Job Publications

List all publications for a job's default ad

Publish Job

Publish the job's default ad to internal sources and job aggregators

Unpublish Job

Unpublish the job from all publication sources

Get Hiring Team

Get the hiring team for a job

Add Hiring Team Member

Add a member to the job's hiring team

Remove Hiring Team Member

Remove a member from the job's hiring team

Get Job Note

Get the note associated with a job

Update Job Note

Update the note associated with a job

List Candidate Offers

Get all offers for a candidate's job application

Get Candidate Offer

Get a specific offer for a candidate's job application

Get Offer Approval

Get latest approval request for candidate's offer

Search Offers

Search offers with filters

List Offer Documents

Get list of documents related to sent offer

Get Offer Document

Get a specific document from a sent offer

List Postings

Lists active postings published by a given company

List Company Departments

List departments for a given company

Get Posting

Get posting by posting id or uuid for a given company

Get Candidate Reviews

Retrieves all reviews for specified candidate and job

Get Review

Retrieves a review by ID

Create Review

Creates a review for a candidate

Update Review

Updates a review by ID

Delete Review

Deletes a review by ID

Get Job Review Criteria

Retrieves all criteria for specified job

List Users

List users of your company

Create User

Create a new user in your company

Get Current User

Get details of the authenticated user

Get User

Get details of a user by ID

Reset User Password

Send a password reset email to a user

Send User Activation Email

Send an activation email to a user

Activate User

Activate a user account

Deactivate User

Deactivate a user account

List System Roles

List all available system roles

Assign Users To Access Group

Assign multiple users to an access group

Remove User From Access Group

Remove a user from an access group

Events

Application Candidate Health Check Job Job Ad

15 events

Event

Description