API Documentation

Groups

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
Name Description
domain Required String The workspace domain.
Example
Request
GET https://api.buddy.works/workspaces/buddy/groups
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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"
    }
  ]
}

Create

Creates a new group. Restricted to admins only.

Required scopes: WORKSPACE

Resource URL
POST /workspaces/:domain/groups
URL Parameters
Name Description
domain Required String The workspace domain.
POST Parameters
Name Description
name Required String The name of the group.
description String The description of the group.
Example
Request
POST https://api.buddy.works/workspaces/buddy/groups
{
  "name": "JAVA",
  "description": "Java developers"
}
Sample Response
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/groups/1",
  "html_url": "https://app.buddy.works/buddy/group/1",
  "id": 1,
  "name": "JAVA",
  "description": "Java developers"
}

Get

Returns a single group.

Required scopes: WORKSPACE

Resource URL
GET /workspaces/:domain/groups/:group_id
URL Parameters
Name 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
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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"
}

Edit

Updates existent group properties.

Required scopes: WORKSPACE

Resource URL
PATCH /workspaces/:domain/groups/:group_id
URL Parameters
Name Description
domain Required String The workspace domain.
group_id Required Integer The numerical ID of the desired group.
POST Parameters
Name Description
description String The description of the group.
name String The name of the group.
Example
Request
PATCH https://api.buddy.works/workspaces/buddy/groups/1
{
  "description": "Developers"
}
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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"
}

Delete

Deletes a group.

Required scopes: WORKSPACE

Resource URL
DELETE /workspaces/:domain/groups/:group_id
URL Parameters
Name Description
domain Required String The workspace domain.
group_id Required Integer The numerical ID of the desired group.
Example
Request
DELETE https://api.buddy.works/workspaces/buddy/groups/1
Sample Response
Status: 204 NoContent
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

List group members

Returns all members from the group.

Required scopes: WORKSPACE

Resource URL
GET /workspaces/:domain/groups/:group_id/members
URL Parameters
Name 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/members
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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",
      "title": "Creative director"
    }
  ]
}

Add a group member

Adds a user to the group.

Required scopes: WORKSPACE

Resource URL
POST /workspaces/:domain/groups/:group_id/members
URL Parameters
Name Description
domain Required String The workspace domain.
group_id Required Integer The numerical ID of the desired group.
POST Parameters
Name Description
id Required Integer The numerical ID of the desired user.
Example
Request
POST https://api.buddy.works/workspaces/buddy/groups/1/members
{
  "id": 1
}
Sample Response
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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",
  "title": "Creative director",
  "admin": true,
  "workspace_owner": true
}

Get a group member

Returns a single member of the group.

Required scopes: WORKSPACE

Resource URL
GET /workspaces/:domain/groups/:group_id/members/:member_id
URL Parameters
Name 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
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "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",
  "title": "Creative director",
  "admin": true,
  "workspace_owner": true
}

Delete a group member

Removes a member from the group.

Required scopes: WORKSPACE

Resource URL
DELETE /workspaces/:domain/groups/:group_id/members/:member_id
URL Parameters
Name 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
DELETE https://api.buddy.works/workspaces/buddy/groups/1/members/1
Sample Response
Status: 204 NoContent
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

Get started now

14 days of unlimited trial. No credit card required.