Most of the Customer API endpoints require prior authorization by your app’s user. To get that authorization, your application will first need to make a call to the SmartRecruiters dedicated endpoint (see OAuth 2.0 page for details), passing along a list of the scopes for which access permission is sought.
Scopes let you specify exactly what types of data your app wants to access, and the set of scopes you pass in your call determines what access permissions the user is asked to grant.
Note: Not passing a list of scopes with the authorization call with use default scopes you have defined when registering your App.
You should only request the scope you need at the time of authorization. If in the future you require additional scope, you may forward the user to the authorization URL with that additional scope to be granted. If you attempt to perform a request with an access token that is not authorized for that scope, you will receive an OAuthPermissionsException error return.
To request multiple scopes at once, simply separate the scopes by a space. In the url, this equates to an escaped space (“%20”). So if you are requesting candidate read and write permission, the parameter will look like this:
Note that an empty scope parameter (scope=) is invalid; you must either omit the scope, or specify a non-empty scope list.
On execution of the authorization request call, user is redirected to a page explaining what information has been requested by an App:
Access Permissions Sought
Prompt Shown to User
Read access to user’s candidates list, details, tags, onboarding status, properties, attachments, screening answers and status history.
Add new candidate records on behalf of a user and assign to a General Application or to a Job by uploading a resume or by passing a JSON object. Add attachments.
Read access to candidates’ offers and get offer terms.
Access Offer Terms
Write access to candidate’s status, onboarding status, tags, source and properties
Manage Candidate Status and Properties
Read access to candidate’s status history.
Access Candidate’s status
Read access to job applications
Access job applications
Read access to all company configuration settings for departments, hiring processes, job properties and offer properties. (NOTE: Requires an Admin user role)
Access Company Settings
Write / delete access to all company configuration settings for departments and job properties. (NOTE: Requires an Admin user role)
Manage Company Settings
Read access to user’s jobs list and details.
Write access to user’s jobs, its hiring team and notes.
Write / delete access to user’s jobs publications.
Read access to users in a company. (NOTE: Requires an Admin user role)
Read access to current user.
Access information about my user
Write / delete access to users in a company. (NOTE: Requires an Admin user role)
Create messages to other users.
Delete access to messages.
Access candidate messages.
Read access to analytics data.
Get company information.
Access Company Information
Read access to audit events.
Access Audit Events
Get analytics reports and download report files.
Get analytics reports and download report files
Manage/execute analytics reports.
Manage/execute analytics reports.
Read list of interview types.
Access Interview Types.
Write or delete access to manage interview types.
Create and delete Interview Types.
Create, update or delete interviews.
Create, update and delete Interviews and Timeslots.
Access Interviews and Timeslots.
Read user’s webhook subscriptions and get details of specific subscription.
View webhook subscriptions.
Create new webhook subscriptions.
Create new webhook subscription.
Delete webhook subscriptions.
Delete webhook subscription.
Create, read and delete webhook subscriptions
View, create and delete webhook subscriptions.
Read access to reviews
Write access to reviews
Create, update and delete reviews
Read access to job and offer approvals
Access job and offer approval requests
Write access to job and offer approvals
Create new job and offer approval requests
Read access to assessment orders
Access Assessment Orders
Updated about 2 months ago