---
updatedAt: 2025-12-02T14:48:35.000Z
agentTools:
  projectIndex: https://developers.smartrecruiters.com/llms.txt
---

# Permission Reference

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](https://developers.smartrecruiters.com/reference/createcandidate-1)                       | `candidate_applications_manage` |
| [RetrieveApplicationConfiguration](https://developers.smartrecruiters.com/reference/getapplyconfigurationforposting-1) | `candidate_applications_manage` |
| [RetrieveCandidateStatus](https://developers.smartrecruiters.com/reference/getapplicationstatus-1)                     | `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](https://smartrecruiters.readme.io/reference/approvalsget-1)    | `approvals_read`   |
| [CreateApproval](https://smartrecruiters.readme.io/reference/approvalscreate-1)    | `approvals_create` |
| [RetrieveApproval](https://smartrecruiters.readme.io/reference/approvalsgetbyid-1) | `approvals_read`   |

# Assessments

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

| Endpoint                                                                                     | Scope Required           |
| :------------------------------------------------------------------------------------------- | :----------------------- |
| [RetrieveAssessmentResult](https://developers.smartrecruiters.com/reference/ordersgetlist-1) | `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](https://smartrecruiters.readme.io/reference/auditget-1) | `audit_events_read` |

# Candidates

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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Endpoint
      </th>

      <th>
        Scope Required
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [ListCandidates](https://smartrecruiters.readme.io/reference/candidatesall-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [CreateCandidate](https://smartrecruiters.readme.io/reference/candidatesadd-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [CreateCandidateFromResume](https://developers.smartrecruiters.com/reference/candidatesresumeadd-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveCandidate](https://smartrecruiters.readme.io/reference/candidatesget-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateCandidate](https://smartrecruiters.readme.io/reference/candidatesupdate-1)
      </td>

      <td>
        `candidate_manage`
      </td>
    </tr>

    <tr>
      <td>
        [DeleteCandidate](https://smartrecruiters.readme.io/reference/candidatesdelete-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [ListCandidateConsents](https://smartrecruiters.readme.io/reference/candidatesconsentdecisions-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [ListCandidateSingleConsent](https://developers.smartrecruiters.com/reference/candidatesconsentstatus-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [CreateCandidateConsents](https://developers.smartrecruiters.com/reference/candidatesconsentrequestbatch-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [CreateCandidateTags](https://developers.smartrecruiters.com/reference/candidatestagsadd-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateCandidateTags](https://developers.smartrecruiters.com/reference/candidatestagsreplace-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [DeleteCandidateTags](https://developers.smartrecruiters.com/reference/candidatestagsdelete-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [ListCandidateTags](https://developers.smartrecruiters.com/reference/candidatestagsget-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveCandidateAttachment](https://developers.smartrecruiters.com/reference/candidatesattachmentsgetforjob-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [DeleteCandidateAttachment](https://developers.smartrecruiters.com/reference/candidatesattachmentsdeleteforjob-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [CreateApplicationToJob](https://developers.smartrecruiters.com/reference/candidatesaddtojob-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [CreateApplicationFromResume](https://developers.smartrecruiters.com/reference/candidatesresumeaddtojob-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveApplication](https://smartrecruiters.readme.io/reference/candidatesgetapplication-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateApplicationStatus](https://developers.smartrecruiters.com/reference/candidatesstatusupdate-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [ListApplicationStatusLog](https://developers.smartrecruiters.com/reference/candidatesstatushistorygetforjob-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [ListApplicationAttachments](https://smartrecruiters.readme.io/reference/candidatesattachmentslistforjob-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [ListApplicationAttachment](https://developers.smartrecruiters.com/reference/candidatesattachmentslistforjob-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [CreateApplicationAttachment](https://smartrecruiters.readme.io/reference/candidatesattachmentsaddforjob-1)
      </td>

      <td>
        `candidates_create`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveApplicationOnboardingStatus](https://smartrecruiters.readme.io/reference/candidatesonboardinggetforjob-1)
      </td>

      <td>
        `candidate_status_read`\
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateApplicationOnboardingStatus](https://smartrecruiters.readme.io/reference/candidatesonboardingupdateforjob-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateApplicationSource](https://developers.smartrecruiters.com/reference/candidatessourceupdate-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [UpdateApplicationPropertyValue](https://developers.smartrecruiters.com/reference/candidatespropertiesvaluesupdateforjob-1)
      </td>

      <td>
        `candidates_manage`
      </td>
    </tr>

    <tr>
      <td>
        [ListApplicationProperties](https://smartrecruiters.readme.io/reference/candidatespropertiesgetforjob-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [ListApplicationScreeningQuestionAnswers](https://developers.smartrecruiters.com/reference/candidatesscreening-answersget-1)
      </td>

      <td>
        `candidates_read`
      </td>
    </tr>

    <tr>
      <td>
        [CandidateResumeParse](https://developers.smartrecruiters.com/reference/candidatesresumeparse)
      </td>

      <td>
        `candidates_parse_resume`
      </td>
    </tr>
  </tbody>
</Table>

# 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](https://developers.smartrecruiters.com/reference/publicgetstatus) | `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](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesall-1)                           | `configuration_read`   |
| [RetrieveCompanyCandidateProperty](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesget-1)                         | `configuration_read`   |
| [ListCompanyCandidatePropertyValues](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesvaluesall-1)                 | `configuration_read`   |
| [CreateCompanyCandidatePropertyValue](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesvaluescreate-1)             | `configuration_manage` |
| [RetrieveCompanyCandidatePropertyValue](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesvaluesget-1)              | `configuration_read`   |
| [UpdateCompanyCandidatePropertyValue](https://developers.smartrecruiters.com/reference/configurationcandidate-propertiesvaluesupdate-1)             | `configuration_manage` |
| [RetrieveCompany](https://developers.smartrecruiters.com/reference/configurationcompanymy-1)                                                        | `company_read`         |
| [ListDepartments](https://developers.smartrecruiters.com/reference/configurationdepartmentall-1)                                                    | `configuration_read`   |
| [CreateDepartment](https://developers.smartrecruiters.com/reference/configurationdepartmentcreate-1)                                                | `configuration_manage` |
| [RetrieveDepartment](https://developers.smartrecruiters.com/reference/configurationdepartmentget-1)                                                 | `configuration_read`   |
| [ListHiringProcesses](https://developers.smartrecruiters.com/reference/configurationhiring-processall-1)                                            | `configuration_read`   |
| [RetrieveHiringProcess](https://developers.smartrecruiters.com/reference/configurationhiring-processget-1)                                          | `configuration_read`   |
| [ListCompanyJobProperties](https://developers.smartrecruiters.com/reference/configurationjob-propertiesall-1)                                       | `configuration_read`   |
| [CreateCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiescreate-1)                                    | `configuration_manage` |
| [RetrieveCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiesget-1)                                     | `configuration_read`   |
| [UpdateCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiesupdate-1)                                    | `configuration_manage` |
| [ActivateCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiesactivate-1)                                | `configuration_manage` |
| DeleteCompanyJobProperty                                                                                                                            | `configuration_manage` |
| [ArchiveCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluesarchive-1)                            | `configuration_manage` |
| [UnarchiveCompanyJobProperty](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluesunarchive-1)                        | `configuration_manage` |
| [ListCompanyJobPropertyValues](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluesget-1)                             | `configuration_read`   |
| [CreateCompanyJobPropertyValue](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluescreate-1)                         | `configuration_manage` |
| [UpdateCompanyJobPropertyValue](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluesupdate-1)                         | `configuration_manage` |
| [ListCompanyJobPropertyValueDependentValues](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsvaluesget-1)     | `configuration_read`   |
| [CreateCompanyJobPropertyValueDependentValue](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsvaluesadd-1)    | `configuration_manage` |
| [DeleteCompanyJobPropertyValueDependentValue](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsvaluesremove-1) | `configuration_manage` |
| [UpdateCompanyJobPropertyValueTranslation](https://developers.smartrecruiters.com/reference/configurationjob-propertiesvaluestranslationspatch-1)   | `configuration_manage` |
| [ListCompanyJobPropertyDependents](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsall-1)                     | `configuration_read`   |
| [CreateCompanyJobPropertyDependent](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentscreate-1)                 | `configuration_manage` |
| [DeleteCompanyJobPropertyDependent](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsremove-1)                 | `configuration_manage` |
| [ListCompanyJobPropertyDependentValues](https://developers.smartrecruiters.com/reference/configurationjob-propertiesdependentsvaluesget-1)          | `configuration_read`   |
| [ListCompanyOfferProperties](https://developers.smartrecruiters.com/reference/configurationoffer-propertiesall-1)                                   | `configuration_read`   |
| [ListCompanyRejectionReasons](https://developers.smartrecruiters.com/reference/configurationreasonsrejectionall-1)                                  | `configuration_read`   |
| [ListCompanyCareerSiteConfigurations](https://developers.smartrecruiters.com/reference/configurationcareersiteslist)                                | `configuration_read`   |
| [RetrieveCompanyCareerSiteConfiguration](https://developers.smartrecruiters.com/reference/configurationcareersitesget)                              | `configuration_read`   |
| [ListCompanyCandidateSourceType](https://developers.smartrecruiters.com/reference/configurationsourcetypes-1)                                       | `configuration_read`   |
| [ListCompanyCandidateSources](https://developers.smartrecruiters.com/reference/configurationsourcevaluesall-1)                                      | `configuration_read`   |
| [RetrieveCompanyCandidateSource](https://developers.smartrecruiters.com/reference/configurationsourcevaluessingle-1)                                | `configuration_read`   |
| [GetManyPredefinedLocations](https://developers.smartrecruiters.com/reference/configurationpredefined-locationsgetmany)                             | `configuration_read`   |
| [CreatePredefinedLocation](https://developers.smartrecruiters.com/reference/configurationpredefined-locationscreateone)                             | `configuration_manage` |
| [DeleteManyPredefinedLocations](https://developers.smartrecruiters.com/reference/configurationpredefined-locationsdeletemany)                       | `configuration_manage` |
| [GetSinglePredefinedLocation](https://developers.smartrecruiters.com/reference/configurationpredefined-locationsgetone)                             | `configuration_read`   |
| [UpdatePredefinedLocation](https://developers.smartrecruiters.com/reference/configurationpredefined-locationsupdateone)                             | `configuration_manage` |
| [DeleteOnePredefinedLocation](https://developers.smartrecruiters.com/reference/configurationpredefined-locationsdeleteone)                          | `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](https://smartrecruiters.readme.io/reference/typesget-1)                                     | `interview_types_read`  |
| [CreateInterviewType](https://smartrecruiters.readme.io/reference/typesupdate-1)                                 | `interview_types_write` |
| [DeleteInterviewType](https://smartrecruiters.readme.io/reference/typesdelete-1)                                 | `interview_types_write` |
| [CreateInterview](https://smartrecruiters.readme.io/reference/interviewscreate-1)                                | `interviews_write`      |
| [RetrieveInterview](https://smartrecruiters.readme.io/reference/interviewsget-1)                                 | `interviews_read`       |
| [UpdateInterview](https://smartrecruiters.readme.io/reference/interviewsupdate-1)                                | `interviews_write`      |
| [DeleteInterview](https://smartrecruiters.readme.io/reference/interviewsdelete-1)                                | `interviews_write`      |
| [UpdateInterviewCandidateStatus](https://smartrecruiters.readme.io/reference/statusescandidateput-1)             | `interviews_write`      |
| [UpdateInterviewInterviewerTimeslotStatus](https://smartrecruiters.readme.io/reference/statusesinterviewerput-1) | `interviews_write`      |
| [CreateInterviewTimeslot](https://smartrecruiters.readme.io/reference/timeslotscreate-1)                         | `interviews_write`      |
| [RetrieveInterviewTimeslot](https://smartrecruiters.readme.io/reference/timeslotsget-1)                          | `interviews_read`       |
| [UpdateInterviewTimeslot](https://smartrecruiters.readme.io/reference/timeslotsupdate-1)                         | `interviews_write`      |
| [DeleteInterviewTimeslot](https://smartrecruiters.readme.io/reference/timeslotsdelete-1)                         | `interviews_write`      |

# Jobs

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

| Endpoint                                                                                         | Scope Required             |
| :----------------------------------------------------------------------------------------------- | :------------------------- |
| [ListJobs](https://smartrecruiters.readme.io/reference/jobsall-1)                                | `jobs_read`                |
| [CreateJob](https://smartrecruiters.readme.io/reference/jobscreate-1)                            | `jobs_manage`              |
| [RetrieveJob](https://smartrecruiters.readme.io/reference/jobsget-1)                             | `jobs_read`                |
| [UpdateJob](https://smartrecruiters.readme.io/reference/jobspatch-1)                             | `jobs_manage`              |
| [UpdateJobHeadcount](https://smartrecruiters.readme.io/reference/jobsheadcountupdate-1)          | `jobs_manage`              |
| [RetrieveJobHiringteam](https://smartrecruiters.readme.io/reference/jobshiring-teamget-1)        | `jobs_read`                |
| [UpdateJobHiringteam](https://smartrecruiters.readme.io/reference/jobshiring-teamadd-1)          | `jobs_manage`              |
| [DeleteJobHiringteamMember](https://smartrecruiters.readme.io/reference/jobshiring-teamremove-1) | `jobs_manage`              |
| [ListJobAds](https://smartrecruiters.readme.io/reference/jobsjobadsall-1)                        | `jobs_read`                |
| [CreateJobAds](https://smartrecruiters.readme.io/reference/jobsjobadscreate-1)                   | `jobs_manage`              |
| [RetrieveJobAd](https://smartrecruiters.readme.io/reference/jobsjobadsget-1)                     | `jobs_read`                |
| [UpdateJobAd](https://smartrecruiters.readme.io/reference/jobsjobadsupdate-1)                    | `jobs_manage`              |
| [ListJobAdPostings](https://smartrecruiters.readme.io/reference/jobsjobadspostingsall-1)         | `jobs_read`                |
| [CreateJobAdPosting](https://smartrecruiters.readme.io/reference/jobsjobadspostingscreate-1)     | `jobs_manage`              |
| [DeleteJobAdPosting](https://smartrecruiters.readme.io/reference/jobsjobadspostingsunpublish-1)  | `jobs_manage`              |
| [RetrieveJobNote](https://smartrecruiters.readme.io/reference/jobsnotesget-1)                    | `jobs_read`                |
| [UpdateJobNote](https://smartrecruiters.readme.io/reference/jobsnotesupdate-1)                   | `jobs_manage`              |
| [ListJobPositions](https://smartrecruiters.readme.io/reference/jobspositionsall-1)               | `jobs_read`                |
| [CreateJobPosition](https://smartrecruiters.readme.io/reference/jobspositionscreate-1)           | `jobs_manage`              |
| [RetrieveJobPosition](https://smartrecruiters.readme.io/reference/jobspositionsget-1)            | `jobs_read`                |
| [UpdateJobPosition](https://smartrecruiters.readme.io/reference/jobspositionsupdate-1)           | `jobs_manage`              |
| [DeleteJobPosition](https://smartrecruiters.readme.io/reference/jobspositionsremove-1)           | `jobs_manage`              |
| [ListJobPublications](https://smartrecruiters.readme.io/reference/jobspublicationall-1)          | `jobs_read`                |
| [CreateJobPublication](https://smartrecruiters.readme.io/reference/jobspublicationcreate-1)      | `jobs_publications_manage` |
| [DeleteJobPublication](https://smartrecruiters.readme.io/reference/jobspublicationunpublish-1)   | `jobs_publications_manage` |
| [UpdateJobStatus](https://smartrecruiters.readme.io/reference/jobsstatusupdate-1)                | `jobs_manage`              |
| [ListJobStatusHistory](https://smartrecruiters.readme.io/reference/jobsstatushistoryget-1)       | `jobs_read`                |

# Job Applications

The Job Applications API lets developers get and delete job applications

| Endpoint                                                                                             | Scope Required            |
| :--------------------------------------------------------------------------------------------------- | :------------------------ |
| [RetrieveJobApplication](https://developers.smartrecruiters.com/reference/job-applicationsgetbyid-1) | `job_applications_read`   |
| [DeleteJobApplication](https://developers.smartrecruiters.com/reference/job-applicationsdeletebyid)  | `job_applications_manage` |

# Messages

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

| Endpoint                                                                            | Scope Required    |
| :---------------------------------------------------------------------------------- | :---------------- |
| [ListMessages](https://smartrecruiters.readme.io/reference/messagesfetch-1)         | `messages_read`   |
| [CreateMessage](https://smartrecruiters.readme.io/reference/messagessharescreate-1) | `messages_write`  |
| [DeleteMessage](https://smartrecruiters.readme.io/reference/messagessharesdelete-1) | `messages_manage` |

# Offers

The Offer API lets developers retrieve offers for candidates.

| Endpoint                                                                                             | Scope Required           |
| :--------------------------------------------------------------------------------------------------- | :----------------------- |
| [ListOffers](https://smartrecruiters.readme.io/reference/candidatesoffersfind-1)                     | `candidates_offers_read` |
| [ListCandidateOffers](https://smartrecruiters.readme.io/reference/candidatesoffersall-1)             | `candidates_offers_read` |
| [RetrieveCandidateOffer](https://smartrecruiters.readme.io/reference/candidatesoffersget-1)          | `candidates_offers_read` |
| [GetDocumentsList](https://developers.smartrecruiters.com/reference/offersdocumentsgetdocumentslist) | `candidates_offers_read` |
| [GetDocument](https://developers.smartrecruiters.com/reference/offersdocumentsgetdocument)           | `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](https://developers.smartrecruiters.com/docs/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](https://smartrecruiters.readme.io/reference/getreports-1)                                     | `reporting_read` |
| [RetrieveReport](https://smartrecruiters.readme.io/reference/getreport-1)                                   | `reporting_read` |
| [ListReportFiles](https://smartrecruiters.readme.io/reference/getreportfiles-1)                             | `reporting_read` |
| [CreateReportFile](https://smartrecruiters.readme.io/reference/generateadhocreport-1)                       | `reporting_read` |
| [RetrieveReportFile](https://smartrecruiters.readme.io/reference/getreportfile-1)                           | `reporting_read` |
| [RetrieveReportFileData](https://smartrecruiters.readme.io/reference/downloadreportfile-1)                  | `reporting_read` |
| [ListRecentReportFiles](https://smartrecruiters.readme.io/reference/getmostrecentreportfile-1)              | `reporting_read` |
| [RetrieveRecentReportFilesData](https://smartrecruiters.readme.io/reference/downloadmostrecentreportfile-1) | `reporting_read` |

# Reviews

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

| Endpoint                                                                    | Scope Required   |
| :-------------------------------------------------------------------------- | :--------------- |
| [ListReviews](https://smartrecruiters.readme.io/reference/reviewsgetlist-1) | `reviews_read`   |
| [CreateReview](https://smartrecruiters.readme.io/reference/reviewscreate-1) | `reviews_write`  |
| [RetrieveReview](https://smartrecruiters.readme.io/reference/reviewsget-1)  | `reviews_read`   |
| [UpdateReview](https://smartrecruiters.readme.io/reference/reviewsupdate-1) | `reviews_write`  |
| [DeleteReview](https://smartrecruiters.readme.io/reference/reviewsdelete-1) | `reviews_delete` |

# Users

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

| Endpoint                                                                                         | Scope Required |
| :----------------------------------------------------------------------------------------------- | :------------- |
| [ListUsers](https://smartrecruiters.readme.io/reference/usersall-2)                              | `users_read`   |
| [CreateUser](https://smartrecruiters.readme.io/reference/userscreate-2)                          | `users_manage` |
| [RetrieveUser](https://smartrecruiters.readme.io/reference/usersget-2)                           | `users_read`   |
| [UpdateUser](https://smartrecruiters.readme.io/reference/usersupdate-2)                          | `users_manage` |
| [ActivateUser](https://smartrecruiters.readme.io/reference/usersactivationactivate-2)            | `users_manage` |
| [DeactivateUser](https://smartrecruiters.readme.io/reference/usersactivationdeactivate-2)        | `users_manage` |
| [CreateUserPassword](https://smartrecruiters.readme.io/reference/usersactivationemailsend-2)     | `users_manage` |
| [UpdateUserPassword](https://smartrecruiters.readme.io/reference/userspasswordreset-1)           | `users_manage` |
| [UpdateUserAvatar](https://smartrecruiters.readme.io/reference/usersavatarupdate-2)              | `users_manage` |
| [ListAccessGroups](https://smartrecruiters.readme.io/reference/access-groupsall-1)               | `users_read`   |
| [UpdateAccessGroupUsers](https://smartrecruiters.readme.io/reference/access-groupsusersassign-1) | `users_manage` |
| [DeleteAccessGroupUser](https://smartrecruiters.readme.io/reference/access-groupsusersremove-1)  | `users_manage` |
| [ListSystemRoles](https://smartrecruiters.readme.io/reference/system-rolesall-1)                 | `users_read`   |
| [RetrieveMyUser](https://smartrecruiters.readme.io/reference/usersme-2)                          | `user_me_read` |

# Webhook Subscriptions

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

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Endpoint
      </th>

      <th>
        Required Scope
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [ListWehbookSubscriptions](https://smartrecruiters.readme.io/reference/subscriptionsgetall-1)
      </td>

      <td>
        `webhooks_read`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [CreateWebhookSubscription](https://smartrecruiters.readme.io/reference/subscriptionscreate-1)
      </td>

      <td>
        `webhooks_write`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveWebhookSubscription](https://smartrecruiters.readme.io/reference/subscriptionsget-1)
      </td>

      <td>
        `webhooks_read`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [DeleteWebhookSubscription](https://smartrecruiters.readme.io/reference/subscriptionsdelete-1)
      </td>

      <td>
        `webhooks_delete`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [ActivateWebhookSubscription](https://smartrecruiters.readme.io/reference/subscriptionsactivate-1)
      </td>

      <td>
        `webhooks_write`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [ListCallbacksLog](https://smartrecruiters.readme.io/reference/subscriptionssearchcallbacklog-1)
      </td>

      <td>
        `webhooks_read`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [CreateWebhookSubscriptionSecretKey](https://smartrecruiters.readme.io/reference/subscriptionsgeneratesecretkey-1)
      </td>

      <td>
        `webhooks_write`\
        `webhooks_manage`
      </td>
    </tr>

    <tr>
      <td>
        [RetrieveWebhookSubscriptionSecretKey](https://smartrecruiters.readme.io/reference/subscriptionsgetsecretkey-1)
      </td>

      <td>
        `webhooks_read`\
        `webhooks_manage`
      </td>
    </tr>
  </tbody>
</Table>

# URL Shortener

URL Shortener API allows users to create shortened URLs.

| Endpoint                                                                | Required Scope        |
| :---------------------------------------------------------------------- | :-------------------- |
| [ShortenUrl](https://smartrecruiters.readme.io/reference/publicshorten) | `url_shortener_write` |