SMsmartrecruiters
notification-preferences

Get list of employee notifications preferences for a specific channel.

get/employee-preferences

Request

  • Base URL
    https://api.smartrecruiters.com/notification-preferences
  • URL
    https://api.smartrecruiters.com/notification-preferences/employee-preferences
  • Auth
    • OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: notification_preferences:read
    • or API key in header x-smarttoken

Query parameters

channel'SLACK' | 'TEAMS' | 'EMAIL' required

Response

Fetched employee preferences. May return empty list.

idstring uuid required

Unique identifier of the preference

hiringTeamRolestring required

Hiring team role

notificationType'ADDED_TO_HIRING_TEAM' | 'ASSESSMENT_RESULTS' | 'ASSESSMENT_UPDATED' | 'CANDIDATE_APPLIED' | 'CANDIDATE_DEFERRED' | 'CANDIDATE_OFFERED' | 'CANDIDATE_RATED' | 'CANDIDATE_RE_ENGAGED' | 'CANDIDATE_REPLIED_TO_EMAIL' | 'CANDIDATE_REPLIED_TO_SMART_MESSAGE' | 'CANDIDATE_WITHDRAWN' | 'COMMENTS_ON_MENTIONED_POSTS' | 'COMMENTS_ON_MY_POSTS' | 'EMAIL_FROM_COLLEAGUE_TO_CANDIDATE_WITHIN_CONVERSATION' | 'EVENT_MANAGEMENT_DAILY_DIGEST' | 'EVENT_MANAGEMENT_SESSION_SCHEDULED' | 'FEEDBACK_IS_SUBMITTED_BY_INTERVIEWER' | 'INTERVIEW_ACCEPTED_BY_CANDIDATE' | 'INTERVIEW_CANCELLED_BY_CANDIDATE' | 'INTERVIEW_FEEDBACK' | 'INTERVIEW_INVITATION' | 'INTERVIEW_REMINDER' | 'NEW_HIRES' | 'NEW_HIRING_TEAM_MEMBERS' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_INTERVIEWER' | 'SELF_SCHEDULING_NO_SLOTS_AVAILABLE_JOB_CREATOR' | 'UPCOMING_INTERVIEWS' | 'WEEKLY_DIGEST' required

Type of notification

enabledboolean required

Whether notification is enabled

Example response

[
  {
    "hiringTeamRole": "HIRING_MANAGER",
    "notificationType": "CANDIDATE_APPLIED",
    "enabled": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.