Get
User group
Shows details of an user group.
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/groups/:group_id
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
group_id Required | Integer | The numerical ID of the desired group. |
Example
Request
GET https://api.buddy.works/workspaces/buddy/groups/1
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",
"html_url": "https://app.buddy.works/buddy/group/1",
"id": 1,
"name": "Dev Team",
"description": "Developers"
}
Group member
Returns a single member of a user group.
Required scopes: WORKSPACE
Resource URL
GET /workspaces/:domain/groups/:group_id/members/:member_id
URL Parameters
Name | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
group_id Required | Integer | The numerical ID of the desired group. |
member_id Required | Integer | The numerical ID of the desired user. |
Example
Request
GET https://api.buddy.works/workspaces/buddy/groups/1/members/1
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/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",
"admin": true,
"workspace_owner": true,
"status": "MANAGER"
}
Last modified on July 25, 2022