Endpoints

This section aims at presenting all the base endpoints that are part of the SmartRecruiters User API.

Available endpoints:

When a new user is created in SmartRecruiters, before he / she can sign in to the system, needs to activate the account. It can be performed by using the /users /activation method which activates an account straight away and allows to sign in, or by sending an activation email by using /users /activation-email method. In this case, a user will need to open a link in the activation email and follow steps on the screen.

In an effort to make things consistent, we present each of these methods using the structure below:

  1. Request – GET method to communicate to our API
  2. Path Parameters – all of these are required
  3. Query Parameters – all of these are optional
  4. Response Body
  5. Example http request
  6. Example response