For AI agents: visit https://developers.smartrecruiters.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

API Reference

Guides API Reference Changelog

Apply API

Overview
Application API

Approvals API

Overview
approvals

Apps Integrations API

partner-api
- Enables integrationpost
Overview

Assessment Partner Application

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

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 API

Overview
candidate-status
- Get candidate statusget

Configuration API

configuration
predefined-locations
Overview

Event management API

events
Overview

Feed

feed
Overview

Interviews

Overview
interview types
interviews
statuses
timeslots

Job Applications API

Overview
job-applications

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

message-templates
Overview

Offers API

Overview
offers

Partners public API (deprecated)

offers
- Search offers by criteriaget
configs
Overview

Posting API

postings
Overview

Reviews

Overview
reviews
scorecards
- Retrieves all criteria for specified jobget

Reporting API

Overview
files
- Get report fileget
- Download report fileget
reports

Self Scheduling API

self-schedules
Overview

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
Overview

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

Notifications API

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

Overview

OpenAPI specification

Updated 8 months ago

Returns the automated schedule available slots count based on interviewers availability and specified date params.

Overview

Did this page help you?

Updated 8 months ago

Returns the automated schedule available slots count based on interviewers availability and specified date params.

Overview

Did this page help you?