List users by Status
Returns a list of filtered users based on activation status, first-time log-in, and type of users to be returned. It requires the View Direct Messages
and View Outside Room
permission.
HTTP Method | URL | Requires Auth |
---|---|---|
|
|
Query Parameters
This endpoint supports the optional Pagination parameters.
Key | Example Value | Description |
---|---|---|
|
| Filter users based on their activation status. It can either be |
|
| Filter the users who have logged into their accounts for the first time. |
|
| Filter the type of users to be returned. For example, 'bot', 'user', 'app', etc. |
|
| Filter the users returned based on a list of roles. |
|
| Filter the list of users returned based on a search term |
Example Call
Example Response
Change Log
Version | Description |
---|---|
6.8.0 | Added |
Last updated