User groups

  • GET
  • /workspaces
  • /:workspace
  • /groups

Returns all groups in the workspace

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

Response

RESPONSE BODY
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
groupsShortGroupView[]

Last modified on Jan 26, 2026

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/groups" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "Content-Type: application/json"
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/my-workspace/groups", "html_url": "https://app.buddy.works/my-workspace/groups", "groups": [ { "url": "https://api.buddy.works/workspaces/my-workspace/groups/123", "html_url": "https://app.buddy.works/my-workspace/-/group/123", "id": 123, "name": "developers", "description": "Development team members" }, { "url": "https://api.buddy.works/workspaces/my-workspace/groups/124", "html_url": "https://app.buddy.works/my-workspace/-/group/124", "id": 124, "name": "designers", "description": "UI/UX design team" } ] }
STATUS
200 OK