Jump to Content

Guides API Reference

Guides API Reference

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 API

Overview
feed
info
- /info/metrics.prometheusget

Interviews

Overview
interview types
interviews
statuses
timeslots

Jobs API

Overview
jobs

Job Applications API

Overview
job-applications
- Get a job applicationget

Messages API

Overview
messages

Offers API - version 1

Overview
offers

partners-public-api (deprecated)

Overview
comments
info
- /info/metrics.prometheusget
attachments
results
assessments
configs
offers

Posting API - version 1

Overview
postings

Reporting API

Overview
files
- Download report fileget
- Get report fileget
reports

Reviews

Overview
reviews

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
assignments-submissions

Users API

Overview
users

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

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 API

Overview
feed
info
- /info/metrics.prometheusget

Interviews

Overview
interview types
interviews
statuses
timeslots

Jobs API

Overview
jobs

Job Applications API

Overview
job-applications
- Get a job applicationget

Messages API

Overview
messages

Offers API - version 1

Overview
offers

partners-public-api (deprecated)

Overview
comments
info
- /info/metrics.prometheusget
attachments
results
assessments
configs
offers

Posting API - version 1

Overview
postings

Reporting API

Overview
files
- Download report fileget
- Get report fileget
reports

Reviews

Overview
reviews

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
assignments-submissions

Users API

Overview
users

Users API (Deprecated)

Overview
users

Webhooks

Overview
subscriptions

Overview

SmartRecruiters endpoints specification for Assessment Partner Integration V2.

Please see:
configuration
integration
result

OpenAPI Specification