Read User

Retreive a SmartRecruiters user profile by user ID.

Required fields are indicated by a red asterisk.

Unless otherwise mentioned, all fields are text.


  • User

    • User ID: unique identifier of the user


  • User ID: unique identifier of the user

  • Email: email address of the user

  • First Name: first name of the user

  • Last Name: last name of the user

  • System Role ID: assigned user role; options are EMPLOYEE, RESTRICTED, STANDARD, EXTENDED, or ADMINISTRATOR

  • External Data: third-party data that can be synced with your SmartRecruiters instance; for example, employee ID numbers

  • SSO Identifier: unique identifier for an SSO-enabled user; can be email address

  • Language: preferred language of the user; for example, de for German

  • Active: indicates whether the user is active

  • Updated On: date and time when user's profile was last updated in ISO 8601

  • Location

    • Country: user's country

    • Country Code: user's country code

    • Region: user's region

    • Region Code: user's region code

    • City: user's city of residence

    • Address: user's home address

    • Postal Code: user home postal code

  • Access Groups

    • Group ID: unique identifier of the group

    • Group Name: name of the group