SMsmartrecruiters
schedule-preferences

Find schedule preferences

Finds schedule preferences for provided user.

get/schedule/preferences/users/{userId}

Request

  • Base URL
    https://api.smartrecruiters.com/interview-templates
  • URL
    https://api.smartrecruiters.com/interview-templates/schedule/preferences/users/{userId}
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Client credentials
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: schedule_preferences_read

Path parameters

userIdstring ^[a-fA-F0-9]{24}$ required

Identifier of the user for which schedule preferences should be found

Response

Successfully found schedule preferences.

availabilityHoursobject

Days of the week (Mo - Su) along with availability slots which define the hours when the user is available for interviews

bufferTimeInMinutesinteger

The amount of time in minutes that the user needs between any two consecutive interviews

advanceTimeInMinutesinteger

The flag indicating the minimum amount of time in minutes that the user needs to prepare for an interview

dailyInterviewLimitinteger

The maximum number of interviews that the user can conduct in a day

Example response

{
  "availabilityHours": {
    "MONDAY": [
      {
        "start": "09:00:00",
        "end": "17:00:00"
      }
    ]
  },
  "availabilitySpecificSlots": [
    {
      "start": "2024-06-10T14:00:00.000000Z",
      "end": "2024-06-11T14:30:00.000000Z"
    }
  ],
  "bufferTimeInMinutes": 15,
  "advanceTimeInMinutes": 1440,
  "dailyInterviewLimit": 2
}

Changes

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