Groups

Core

GET

List groups

/groups

List groups (both global and workspace).

Filters

Provided via query string:

Name Type Description
id String ID
parentId String Parent group's ID
ownerId String Owning user's ID
workspaceId String Workspace ID
name String Name

Parameters

Provided via query string:

Name Type Description
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of Group objects.

GET

Count groups

/groups/count

Count groups (both global and workspace).

Filters

Provided via query string:

Name Type Description
id String ID
parentId String Parent group's ID
ownerId String Owning user's ID
workspaceId String Workspace ID
name String Name

Response

A Count object.

GET

Get a group

/groups/{id}

Find a group by ID.

Response

A Group object.

Members

GET

List IDs of group members

/groups/{id}/user-ids

List the IDs of members of a group.

Parameters

Provided via query string:

Name Type Description
expand Boolean Include members from child groups (defaults to false)
limit Number Number of items to return
offset Number Number of items to skip before returning

Response

An array of user IDs.

results matching ""

    No results matching ""