In OAuth flows, your application needs to exchange either a client credential or an authorization code for an access token before calling a SmartRecruiters endpoint. Each access token is tied to a defined scope which describes the resource permission your application is seeking from the resource owner.
In many cases, the resource owner needs to review the scopes via a SmartRecruiter page or a dialog box to grant access to your application.
Below is the list of access scopes and description of each scope:
|Scope||Description||Prompt Displayed to User|
|Write access to create job approval requests and offer approval requests||Create new job approval and offer approval requests|
|Read access to job approval requests and offer approval requests||Access job approval and offer approval requests|
|Read access to audit events||Access audit events|
|Write access to add new candidate records by assigning the candidate to a job or general application.|
Write access to add attachment to a candidate
|Read access to candidates list, candidate details, tags, onboarding status, properties, attachments, screening question answers and status history||Access candidates|
|Write access to edit a candidate's status, onboarding status, tags, source and candidate properties||Manage candidate status and properties|
|Read access to candidates' offers and offer terms||Access candidate offer terms|
|Read access to candidates' status history||Access candidate status|
|Read access to company information||Access company information|
|Read access to all company settings including departments, hiring processes, job properties and offer properties||Access company settings|
|Write access to all company settings including departments, hiring process, job properties and offer properties||Manage company settings|
|Write access to create, update and delete interviews||Create, update and delete interviews and timeslots|
|Read access to interviews||Access interviews and timeslots|
|Write access to create and delete interview types||Create and delete interview types|
|Read access to interview types||Access interview types|
|Write access to jobs, hiring team and notes||Create and manage jobs|
|Read access to jobs and detail||Access jobs|
|Write access to create and delete job publications||Publish and unpublish jobs|
|Create messages to users in SmartRecruiters||Message users|
|Delete messages that were sent to users in SmartRecruiters||Manage messages|
|Read access to messages||Access messages|
|Read access to ReportBuilder's reports and report files||Access analytics reports and download report files|
|Manage/execute analytics reports||Manage/execute analytics reports|
|Write access to create reviews on applications||Create, update and delete reviews|
|Read access to reviews on applications||Access reviews|
|Write access to create, update and delete users of the company||Manage users|
|Read access to retrieve users of the company||Access users|
|Read access to user information of which the API credential is associated to||Access my user|
|Create new webhook subscriptions||Create webhook subscriptions|
|Delete webhook subscriptions||Delete webhook subscriptions|
|Read only access to retrieve webhook subscriptions||View webhook subscriptions|
|Read and write access to create, delete and retrieve webhook subscriptions||Create, delete and view webhook subscriptions|
The following sections list and describe SmartAPI resources, their endpoints and the OAuth scopes needed to access them:
The Approval API lets developers to create and to retrieve approval requests for publishing jobs and for sending out offers to candidates.
The Assessment API lets developers to retrieve assessment results and attachments of applications
The Audit API lets developers retrieve event logs that captured actions performed by both end users and system users.
The Candidate API lets developers create, manage and retrieve information on candidates and candidate applications.
The Configuration API lets developers retrieve and manage the company's configuration such as custom job fields, candidate fields and hiring processes.
The Interview API lets developers create and manage interviews and retrieve information of interviews (created by the Interview API) of candidates.
The Job API lets developers create, manage and retrieve information on jobs.
The Message API lets developers retrieve and manages messages to users.
The Offer API lets developer retrieve offers for candidates.
Postings Resource Access Scopes
Postings endpoints are one of the oldest endpoints SmartRecruiters have and these endpoints currently do not support the use of OAuth 2.0.
We are planning to provide a new version of these endpoints that supports OAuth 2.0. In the mean time, please use API Key instead if you are working with the Postings resources.
The Report API lets developers schedule single or periodic download of ReportBuilder's reports and report files.
The Review API lets developers retrieve, create and update reviews of candidate applications.
The User API lets developers access and manage user information, status, roles and permissions.
The Webhook Subscriptions API lets developers create and manage subscriptions for event notifications from the SmartRecruiters Public API service.
Updated 3 months ago