API Reference version 2

Get all users

GET/v2/user

List all users in the group.

Authentication required, with scope view_group.
Accessible by group clients, users.

Query parameters

Type Parameter Description Required?
integer start-index

The start index for the result set

Defaults to 0.

integer max-results

The maximum number of results.

Valid length range: 0 - 1000.

Defaults to 100.

boolean include-guests

Include active guest users in response. Otherwise, no guest users will be included.

Defaults to false.

boolean include-deleted

Include deleted users in response

Defaults to false.

200 application/json
Type Property Description Required?
array items

An array of the following objects.

Required
string mention_name

User's @mention name

Required
string version

An etag-like random version string.

Required
integer id

The user ID

Required
object links

URLs to retrieve user information

Required
string self

The link to use to retrieve the user information

Required
string name

The display user name

Required
integer startIndex

The start index for this set of results.

Required
integer maxResults

The maximum number of results returned.

Valid length range: 1 - 1000.

Required
object links

An object with the following properties.

Required
string self

The URL for this resource.

Required
string prev

The URL to retrieve the previous set of results.

string next

The URL to retrieve the next page of results.