List
User groups
Returns all groups in the workspace according to the “Who can see what?” article in the help guide
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/groups
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
Example
Request
GET https://api.buddy.works/workspaces/buddy/groups
Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/groups",
"html_url": "https://app.buddy.works/buddy/people",
"groups": [
{
"url": "https://api.buddy.works/workspaces/buddy",
"html_url": "https://app.buddy.works/buddy/group/1",
"id": 1,
"name": "Dev Team",
"description": "Developers"
}
]
}
Group members
Returns all members from the group.
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/groups/:group_id/members
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
group_id Required | String | The numerical ID of the desired group. |
Example
Request
GET https://api.buddy.works/workspaces/buddy/groups/1/members
Sample Response
HTTP
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/groups/1/members",
"html_url": "https://app.buddy.works/buddy/group/1/members",
"members": [
{
"url": "https://api.buddy.works/workspaces/buddy/groups/1/members/1",
"html_url": "https://app.buddy.works/buddy/profile/1",
"id": 1,
"name": "Mike Benson",
"avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
"status": "MANAGER"
}
]
}
Last modified on July 26, 2022