Skip to main content

Get users list

POST 

/getUsers

Returns a page of the members the Users widget lists, excluding the current user, following the widget's settings: display mode (all members, by role or hand-picked), sort order and search. The route also answers GET with the same parameters.

It answers only a viewer the Users widget is shown to: one of the mini widget bar, side panel or mobile tab bar has the Users tab on and its role restriction does not hide it from the viewer. A visitor who is not logged in, or a guest, also needs guest chat on. Anyone else gets 401 (not logged in) or 403.

Request#

Responses#

A page of members