Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

All

Pages

Start typing to search…

Apply API

Overview
Application API

Approvals API

Overview
approvals

Apps Integrations API

partner-api
- Enables integrationpost
Overview

Assessment Partner Application

Overview
integration
- Shows consent form on partner sideget
- Removes integration on partner sidedel
packages
- Retrieves a list of packagesget
- Retrieves a package by idget
token
- Exchange credentials for an access tokenpost
orders
- Orders assessment package for candidatepost
- Orders inline assessment package for candidatepost

Assessment Partner API

Overview
configuration
- get partner configurationget
- saves configuration for partnerput
integration
- enable the company integrationpost
result
- updates package resultpatch
- add attachment to orderpost

Assessments API

Overview
assessment orders
- Retrieves all assessment orders for specified applicationget

Audit API

Overview
audit
- List audit eventsget

Candidates API

Overview
candidates

Candidate status Public API

candidate-status
- Get candidate statusget
Overview

Configuration API

configuration
predefined-locations
Overview

Event management API

Overview
events

Feed

feed
Overview

Interviews

Overview
interview types
interviews
statuses
timeslots

Job Applications API

Overview
job-applications
- Get a job applicationget
- Delete a job applicationdel

Interview Templates API

interview-templates
job-level-interview-templates
schedule-preferences
- Find schedule preferencesget
Overview

Jobs API

Overview
jobs

Messages API

Overview
messages

Message templates API

Overview
message-templates

Offers API - version 1

Overview
offers

partners-public-api (deprecated)

offers
- Search offers by criteriaget
Overview
configs

Posting API - version 1

Overview
postings

Reviews

Overview
scorecards
- Retrieves all criteria for specified jobget
reviews

Reporting API

Overview
files
- Get report fileget
- Download report fileget
reports

Self Scheduling API

self-schedules

SmartOnboard

Overview
new-hires
- Returns details for a single New Hireget
onboarding-processes
- Returns details of a single Onboarding Processget
assignments
- Returns Assignments associated with a single Onboarding Processget
- Returns specific Assignment associated with a single Onboarding Processget
assignments-submissions

Users API

users
Overview

Url shortener API

shortener
- Shorten URLpost

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

Notifications API

notification-preferences
notification-types
- Find all supported notification types along with applicable roles and channels they can be delivered.get

Status of candidate consent

get

https://api.smartrecruiters.com/candidates/{id}/consent

Get candidate consent status

Language

Credentials

Click Try It! to start a request and see the response here!