Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Apply API

Overview
Application API

Approvals API

Overview
approvals

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

Assessment Partner Application

Overview
integration
- Shows consent form on partner sideget
- Removes integration on partner sidedelete
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

Assessments API

Overview
assessment orders
- Retrieves all assessment orders for specified applicationget

Audit API

Overview
audit
- List audit eventsget

Candidates API

Overview
candidates

Configuration API

Overview
configuration

Feed

Overview
feed

Interviews

Overview
interview types
interviews
statuses
timeslots

Jobs API

Overview
jobs

Job Applications API

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

Messages API

Overview
messages

Offers API - version 1

Overview
offers

partners-public-api (deprecated)

Overview
offers
configs
assessments
results
attachments
comments

Posting API - version 1

Overview
postings

Reporting API

Overview
files
- Get report fileget
- Download report fileget
reports

Reviews

Overview
reviews
scorecards
- Retrieves all criteria for specified jobget

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

Overview
users

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

Event management API

Overview
events

Apply API

Overview
Application API

Approvals API

Overview
approvals

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

Assessment Partner Application

Overview
integration
- Shows consent form on partner sideget
- Removes integration on partner sidedelete
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

Assessments API

Overview
assessment orders
- Retrieves all assessment orders for specified applicationget

Audit API

Overview
audit
- List audit eventsget

Candidates API

Overview
candidates

Configuration API

Overview
configuration

Feed

Overview
feed

Interviews

Overview
interview types
interviews
statuses
timeslots

Jobs API

Overview
jobs

Job Applications API

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

Messages API

Overview
messages

Offers API - version 1

Overview
offers

partners-public-api (deprecated)

Overview
offers
configs
assessments
results
attachments
comments

Posting API - version 1

Overview
postings

Reporting API

Overview
files
- Get report fileget
- Download report fileget
reports

Reviews

Overview
reviews
scorecards
- Retrieves all criteria for specified jobget

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

Overview
users

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

Event management API

Overview
events

Overview

SmartRecruiters endpoints specification for Assessment Partner Integration V2.

Please see:
configuration
integration
result

OpenAPI Specification