The following sections list and describe SmartAPI resources, their endpoints, and the OAuth scopes needed to access them.

Applications

The Application API lets developers create and retrieve applications' status from candidate perspective

Endpoint	Scope Required
CreateCandidateApplication	`candidate_applications_manage`
RetrieveApplicationConfiguration	`candidate_applications_manage`
RetrieveCandidateStatus	`candidate_applications_manage`

Approvals

The Approval API lets developers create and retrieve approval requests for publishing jobs and for sending out offers to candidates.

Endpoint	Scope Required
ListUserApprovals	`approvals_read`
CreateApproval	`approvals_create`
RetrieveApproval	`approvals_read`

Assessments

The Assessment API lets developers retrieve assessment results and attachments of applications

Endpoint	Scope Required
RetrieveAssessmentResult	`assessment_orders_read`

Audits

The Audit API lets developers retrieve event logs that captured actions performed by both end users and system users.

Endpoint	Scope Required
ListAuditEvents	`audit_events_read`

Candidates

The Candidate API lets developers create, manage and retrieve information on candidates and candidate applications.

Endpoint	Scope Required
ListCandidates	`candidates_read`
CreateCandidate	`candidates_create`
CreateCandidateFromResume	`candidates_create`
RetrieveCandidate	`candidates_read`
UpdateCandidate	`candidate_manage`
DeleteCandidate	`candidates_manage`
ListCandidateConsents	`candidates_read`
ListCandidateSingleConsent	`candidates_read`
CreateCandidateConsents	`candidates_create`
CreateCandidateTags	`candidates_manage`
UpdateCandidateTags	`candidates_manage`
DeleteCandidateTags	`candidates_manage`
ListCandidateTags	`candidates_manage`
RetrieveCandidateAttachment	`candidates_read`
DeleteCandidateAttachment	`candidates_create`
CreateApplicationToJob	`candidates_create`
CreateApplicationFromResume	`candidates_create`
RetrieveApplication	`candidates_read`
UpdateApplicationStatus	`candidates_create`
ListApplicationStatusLog	`candidates_read`
ListApplicationAttachments	`candidates_read`
ListApplicationAttachment	`candidates_read`
CreateApplicationAttachment	`candidates_create`
RetrieveApplicationOnboardingStatus	`candidate_status_read` `candidates_read`
UpdateApplicationOnboardingStatus	`candidates_manage`
UpdateApplicationSource	`candidates_manage`
UpdateApplicationPropertyValue	`candidates_manage`
ListApplicationProperties	`candidates_read`
ListApplicationScreeningQuestionAnswers	`candidates_read`

Candidate status

The Candidate status API allows retrieving an application status that is visible from the candidate's point of view.

Endpoint	Scope Required
GetStatus	`candidate_view_application_status_read`

Configuration

The Configuration API lets developers retrieve and manage the company's configuration such as custom job fields, candidate fields, and hiring processes.

Endpoint	Scope Required
ListCompanyCandidateProperties	`configuration_read`
RetrieveCompanyCandidateProperty	`configuration_read`
ListCompanyCandidatePropertyValues	`configuration_read`
CreateCompanyCandidatePropertyValue	`configuration_manage`
RetrieveCompanyCandidatePropertyValue	`configuration_read`
UpdateCompanyCandidatePropertyValue	`configuration_manage`
RetrieveCompany	`company_read`
ListDepartments	`configuration_read`
CreateDepartment	`configuration_manage`
RetrieveDepartment	`configuration_read`
ListHiringProcesses	`configuration_read`
RetrieveHiringProcess	`configuration_read`
ListCompanyJobProperties	`configuration_read`
CreateCompanyJobProperty	`configuration_manage`
RetrieveCompanyJobProperty	`configuration_read`
UpdateCompanyJobProperty	`configuration_manage`
ActivateCompanyJobProperty	`configuration_manage`
DeleteCompanyJobProperty	`configuration_manage`
ArchiveCompanyJobProperty	`configuration_manage`
UnarchiveCompanyJobProperty	`configuration_manage`
ListCompanyJobPropertyValues	`configuration_read`
CreateCompanyJobPropertyValue	`configuration_manage`
UpdateCompanyJobPropertyValue	`configuration_manage`
ListCompanyJobPropertyValueDependentValues	`configuration_read`
CreateCompanyJobPropertyValueDependentValue	`configuration_manage`
DeleteCompanyJobPropertyValueDependentValue	`configuration_manage`
UpdateCompanyJobPropertyValueTranslation	`configuration_manage`
ListCompanyJobPropertyDependents	`configuration_read`
CreateCompanyJobPropertyDependent	`configuration_manage`
DeleteCompanyJobPropertyDependent	`configuration_manage`
ListCompanyJobPropertyDependentValues	`configuration_read`
ListCompanyOfferProperties	`configuration_read`
ListCompanyRejectionReasons	`configuration_read`
ListCompanyCareerSiteConfigurations	`configuration_read`
RetrieveCompanyCareerSiteConfiguration	`configuration_read`
ListCompanyCandidateSourceType	`configuration_read`
ListCompanyCandidateSources	`configuration_read`
RetrieveCompanyCandidateSource	`configuration_read`
GetManyPredefinedLocations	`configuration_read`
CreatePredefinedLocation	`configuration_manage`
DeleteManyPredefinedLocations	`configuration_manage`
GetSinglePredefinedLocation	`configuration_read`
UpdatePredefinedLocation	`configuration_manage`
DeleteOnePredefinedLocation	`configuration_manage`

Interviews

The Interview API lets developers create and manage interviews and retrieve information of interviews (created by the Interview API) of candidates.

Endpoint	Scope Required
ListInterviewTypes	`interview_types_read`
CreateInterviewType	`interview_types_write`
DeleteInterviewType	`interview_types_write`
CreateInterview	`interviews_write`
RetrieveInterview	`interviews_read`
UpdateInterview	`interviews_write`
DeleteInterview	`interviews_write`
UpdateInterviewCandidateStatus	`interviews_write`
UpdateInterviewInterviewerTimeslotStatus	`interviews_write`
CreateInterviewTimeslot	`interviews_write`
RetrieveInterviewTimeslot	`interviews_read`
UpdateInterviewTimeslot	`interviews_write`
DeleteInterviewTimeslot	`interviews_write`

Jobs

The Job API lets developers create, manage and retrieve information on jobs.

Endpoint	Scope Required
ListJobs	`jobs_read`
CreateJob	`jobs_manage`
RetrieveJob	`jobs_read`
UpdateJob	`jobs_manage`
UpdateJobHeadcount	`jobs_manage`
RetrieveJobHiringteam	`jobs_read`
UpdateJobHiringteam	`jobs_manage`
DeleteJobHiringteamMember	`jobs_manage`
ListJobAds	`jobs_read`
CreateJobAds	`jobs_manage`
RetrieveJobAd	`jobs_read`
UpdateJobAd	`jobs_manage`
ListJobAdPostings	`jobs_read`
CreateJobAdPosting	`jobs_manage`
DeleteJobAdPosting	`jobs_manage`
RetrieveJobNote	`jobs_read`
UpdateJobNote	`jobs_manage`
ListJobPositions	`jobs_read`
CreateJobPosition	`jobs_manage`
RetrieveJobPosition	`jobs_read`
UpdateJobPosition	`jobs_manage`
DeleteJobPosition	`jobs_manage`
ListJobPublications	`jobs_read`
CreateJobPublication	`jobs_publications_manage`
DeleteJobPublication	`jobs_publications_manage`
UpdateJobStatus	`jobs_manage`
ListJobStatusHistory	`jobs_read`

Job Applications

The Job Applications API lets developers get and delete job applications

Endpoint	Scope Required
RetrieveJobApplication	`job_applications_read`
DeleteJobApplication	`job_applications_manage`

Messages

The Message API lets developers retrieve and manages messages to users.

Endpoint	Scope Required
ListMessages	`messages_read`
CreateMessage	`messages_write`
DeleteMessage	`messages_manage`

Offers

The Offer API lets developers retrieve offers for candidates.

Endpoint	Scope Required
ListOffers	`candidates_offers_read`
ListCandidateOffers	`candidates_offers_read`
RetrieveCandidateOffer	`candidates_offers_read`
GetDocumentsList	`candidates_offers_read`
GetDocument	`candidates_offers_read`

Postings

🚧
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.

Reports

The Report API lets developers schedule single or periodic downloads of ReportBuilder's reports and report files.

Endpoint	Scope Required
ListReports	`reporting_read`
RetrieveReport	`reporting_read`
ListReportFiles	`reporting_read`
CreateReportFile	`reporting_read`
RetrieveReportFile	`reporting_read`
RetrieveReportFileData	`reporting_read`
ListRecentReportFiles	`reporting_read`
RetrieveRecentReportFilesData	`reporting_read`

Reviews

The Review API lets developers retrieve, create and update reviews of candidate applications.

Endpoint	Scope Required
ListReviews	`reviews_read`
CreateReview	`reviews_write`
RetrieveReview	`reviews_read`
UpdateReview	`reviews_write`
DeleteReview	`reviews_delete`

Users

The User API lets developers access and manage user information, status, roles, and permissions.

Endpoint	Scope Required
ListUsers	`users_read`
CreateUser	`users_manage`
RetrieveUser	`users_read`
UpdateUser	`users_manage`
ActivateUser	`users_manage`
DeactivateUser	`users_manage`
CreateUserPassword	`users_manage`
UpdateUserPassword	`users_manage`
UpdateUserAvatar	`users_manage`
ListAccessGroups	`users_read`
UpdateAccessGroupUsers	`users_manage`
DeleteAccessGroupUser	`users_manage`
ListSystemRoles	`users_read`
RetrieveMyUser	`user_me_read`

Webhook Subscriptions

The Webhook Subscriptions API lets developers create and manage subscriptions for event notifications from the SmartRecruiters Public API service.

Endpoint	Required Scope
ListWehbookSubscriptions	`webhooks_read` `webhooks_manage`
CreateWebhookSubscription	`webhooks_write` `webhooks_manage`
RetrieveWebhookSubscription	`webhooks_read` `webhooks_manage`
DeleteWebhookSubscription	`webhooks_delete` `webhooks_manage`
ActivateWebhookSubscription	`webhooks_write` `webhooks_manage`
ListCallbacksLog	`webhooks_read` `webhooks_manage`
CreateWebhookSubscriptionSecretKey	`webhooks_write` `webhooks_manage`
RetrieveWebhookSubscriptionSecretKey	`webhooks_read` `webhooks_manage`

URL Shortener

URL Shortener API allows users to create shortened URLs.

Endpoint	Required Scope
ShortenUrl	`url_shortener_write`