List 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

NameTypeDescription
domain
Required
StringThe 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"
    }
  ]
}