users

List users of your company

get/users

Request

  • Base URL
    https://api.smartrecruiters.com/user-api/v201804
  • URL
    https://api.smartrecruiters.com/user-api/v201804/users
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: users_read

Query parameters

qstring

full-text search query based on firstName, lastName, email, externalData

personIdExternalstring[]

Filter users by personIdExternal. Repeatable: personIdExternal=A&personIdExternal=B. Max 100 values.

limitinteger

number of elements to return. max value is 100

pageIdstring

Unique identifier for the next page of users

updatedAfterstring date-time

ISO8601-formatted time boundaries for the user update time, Format: yyyy-MM-ddTHH:mm:ss.SSSZZ

Response

List of users in your company

limitinteger
nextPageIdstring

Changes

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