Skip to main content
SmartRecruiters

API types and authentication methods

  1. Last updated
  2. Save as PDF

 

 



Job Board API: Job Boards 

https://dev.smartrecruiters.com/marketplace-api/live-docs/job-board-api/#/feed


Purpose: pulling jobs that the customer(s) selected to post to the given job board using the offer

Requires:

  • Partner Portal account set-up, under the category Job Board

  • The offer created and submitted in your Partner Portal account 

Authentication: Partner API Key, called X-Smart Token that can be found in Partner  Portal account once it is created:

 


 

Assessment API:  Assessments/Checks/Video Interview providers

https://dev.smartrecruiters.com/marketplace-api/live-docs/assessment-offer-config-apis/

Purpose: managing the orders for skills/behavioral tests, background/reference  checks

 

Requires:

  • Partner Portal account set-up, under the category Assessment

  • The offer created and submitted in your Partner Portal account 

Authentication: Partner API Key, called X-Smart Token that can be found in Partner  Portal account once it is created:
 


 

Offers API - a  part of Assessment API, relevant ONLY for Assessments/Checks/Video Interview providers

Purpose: a programmatic alternative to creating assessment offers manually through the Partner Portal account

 

Requires:

Authentication: Partner API Key, called X-Smart Token that can be found in Partner  Portal account as per above.

 

Application API  - job boards, chatbots, career site builders

https://dev.smartrecruiters.com/marketplace-api/live-docs/application-api/

Purpose: sending applications to the customer(s)’ SR account if the apply URL cannot be used and the vendors prefer to host application process on their side.

 

REQUIRED FOR PARTNER USE:

  • Partner Portal account set-up, under the category Assessment OR Job Board (the type does not matter here, but it cannot be an account under RPO category)

  • uuid parameter of the job that is needed to make any action within that API, if it is either pulling the job configuration (screening questions), pushing applications to the specific job or checking the status of the application.

The UUID parameter can be obtained either by pulling jobs from Posting API or Job Board API.

 

Authentication: Partner API Key, called X-Smart Token that can be found in Partner  Portal account once it is created. Only with the Partner API key the vendor will be able to submit applications for multiple customers!


 

 CUSTOMER API


Posting API

https://dev.smartrecruiters.com/customer-api/live-docs/posting-api/#/postings

Purpose: pulling all active, public jobs of the given customer.

 

Requires:

  • Company identifier of the customer that can be provided to the vendor by Partner Operations Team

Authentication: no authentication

NOTE: the default source is CAREER WEBSITE. It needs to be overriden by setting up the dedicated source token that can be provided by Partner Operations Team.

Job API/Candidate API/Message API/Interview API/Configuration API

Purpose: exporting data from the customer’s SR account or importing the data to the customer’s SR account.

Authentication: OAuth 2.0 (you can read more about OAuth in the dedicated section).