List users

get

https://api.happeo.com/users

Returns a list of users. Can only be called by an admin of the organisation.

Query Params

string

Query string to search through user names or emails.

userSource

string

enum

Filter by the source (origin) of the user account details. Practically tells from where the user account information is synchronized from. Ignored if not given. Possible values:

happeo The user was created in Happeo.
gsuite The user has been provided from G Suite.

Allowed:

userType

string

enum

Defaults to regular

Filter by the user type. Returns regular users if not given. Possible values:

regular
system_account

Allowed:

isAdmin

boolean

Filter by the admin status of the user. Ignored if not given.

licensed

boolean

Filter by the Happeo license status of the user. Ignored if not given.

suspended

boolean

Defaults to false

Filter by the suspended status of the user. The default value is false.

pageNumber

int32

Defaults to 1

The page number, starting at 1.

pageSize

int32

Defaults to 10

The number of items in one page of results.

Response

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of Users.