List users

URL Expired

The URL for this request expired after 30 days.

Query Parameters

• q
  string
  Query string to search through user names or emails.

• userSource
  string, enum
  Filter by the source (origin) of the user account details. Possible values:

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

• userType
  string, enum
  Defaults to regular. Possible values:

  • regular
  • system_account

• isAdmin
  boolean
  Filter by the admin status of the user.

• licensed
  boolean
  Filter by the Happeo license status of the user.

• suspended
  boolean
  Defaults to false. Filter by the suspended status of the user.

• 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.

API Request Example

curl --request GET \
     --url 'https://api.happeo.com/users?userType=regular&suspended=false&pageNumber=1&pageSize=10' \
     --header 'accept: application/json'

Response

200