User groups

View as Markdown

GET
/workspaces
/:workspace
/groups

Returns all groups in the workspace according to the “Who can see what?” article in the help guide

Request

REQUIRED SCOPES

WORKSPACE

URL PARAMETERS

workspacerequiredstring

The workspace name.

Last modified on Apr 8, 2025

Group Member Group Members

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/groups" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \

Response

EXAMPLE RESPONSE
{
  "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"
    }
  ]
}