Groups
GET
List groups
/api/groupsList all groups in a 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
Get a group
/api/groups/{id}GET
List members of a group
/api/groups/{id}/usersList all 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 objects.