Request

GET https://api.eloomi.com/v3/users

Query parameters

Parameter name Value Description Additional
per_page integer

How many users to show per page, defaults to all

Optional
page integer

Which page should be fetched from the pagination. Defaults to 1.

Optional
mode string

Which types of users to get.

Possible values are:

  • all
  • pending
  • active
  • inactive
  • suspended
Required
employee_id string

Used when filtering by employee_id

Optional

Request headers

Parameter name Value Description Additional
ClientId string

Provided by eloomi

Required
Authorization string

Look in the documentation for the authentication endpoint on how to construct this

Required

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Users fetched

UsersSuccess
401 Unauthorized

Not allowed

ErrorSuccess