This is an object representing your user in SmartRecruiters. The Users API allows you to create and manage users and their accesses and permissions to different features, jobs and candidate applications in your SmartRecruiters account.

  "email": "[email protected]",
  "firstName": "string",
  "lastName": "string",
  "systemRole": {
    "id": "string",
    "name": "string"
  "externalData": "string",
  "ssoIdentifier": "string",
  "ssoLoginMode": "SSO",
  "language": {
    "code": "bg"
  "id": "string",
  "active": true,
  "updatedOn": "2021-07-27T10:10:58.100Z",
  "location": {
    "country": "string",
    "countryCode": "string",
    "regionCode": "string",
    "region": "string",
    "city": "string",
    "address": "string",
    "postalCode": "string",
    "longitude": "string",
    "latitude": "string"
  "accessGroups": [
      "id": "string",
      "name": "string"

The user object

email string
The user's email address. Event notifications such as interview invitation and direct candidate conversations will be send to this email address.

firstName string
The user's first name

lastName string
The user's last name

systemRole object
An object that reflects permissions and features access of the user across the SmartRecruiters system

  • string
    Unique identifier of the system role
  • name string
    Name of the system role

externalData string
A self-define string data that you can attach to the object. It can be used to store additional information about the object.

ssoIdentifier string
A unique, case sensitive identifier that maps the user between SmartRecruiters and the identity provider. Required if the user is using single sign-on (SSO)

ssoLoginMode string
An object that determines the user's login method only when sigle sign-on (SSO) is enabled at company or employee level. Possible values: SSO and PASSWORD

language object
The display language preference of the user

  • language.code string
    The language code of the user's system display language. Possible values: af, am, ar, az, bg, bn, ca, cs, cy, da, de, el, en, en-GB, es, es-MX, et, eu, fa, fi, fil, fr, fr-CA, ga, gl, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, km, kn, ko, lo, lt, lv, ml, mn, mr, ms, ne, nl, no, pl, pt, pt-BR, ro, ru, si, sk, sl, sr, sv, sw, ta, te, tr, uk, ur, vi, zh-CN, zh-TW, zu

id string
Unique user identifier

active boolean
Whether a user is active or not. An inactive user must be activated before he/she can access the system.

updatedOn date-time
The time when a property of the user was updated. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

location object
The user's location information

  • string
    Name of the country of the user's residence
  • location.countryCode string
    Two-letter, ISO 3166-1 alpha-2 formatted country code of the user location
  • location.regionCode string
    Four-letter ISO 3166-2:US formatted region code for regions in the United State. The regionCode field is not required and not recommend to be used for regions outside of the United States.
  • location.region string
    The user's residence area of description, such as state, province or voivodeship.
  • string
    The city of the user location
  • location.address string
    The address line of the user location
  • location.postalCode string
    ZIP or postal code of the user location
  • float
    ISO 6709 formatted latitude of the user address
  • location.lng string
    ISO 6709 formatted longitude of the user address

accessGroups array of objects
The access groups associated with the user

  • object
    An access group
    • string
      Unique access group identifier
    • string
      Name of the access group