Members

List workspace members

Returns users in the workspace according to the "Who can see what?" article in the help guide (all users for administrators; co-workers for the remaining users).
Required scopes: WORKSPACE

Resource URL
GET
/workspaces/:domain/members
URL Parameters
Name Description
domain Required String The workspace domain.
GET Parameters
Name Description
page Integer The number of the successive page (results are splitted by pages of per_page elements each).
per_page Integer The number of returned elements on the page.
sort_by String Specifies ordering. Can be one of email, name or short_name.
sort_direction String Specifies the direction of ordering. Can be one of ASC or DESC.
Example
Request
GET
https://api.buddy.works/workspaces/buddy/members?page=1&per_page=2&sort_by=name&sort_direction=ASC
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/members",
  "html_url": "https://app.buddy.works/buddy/people",
  "members": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/member/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 workspace member

Adds a user to the workspace. Can be performed by all users, unless restricted to administrators in the workspace settings.
Required scopes: WORKSPACE

Resource URL
POST
/workspaces/:domain/members
URL Parameters
Name Description
domain Required String The workspace domain.
POST Parameters
Name Description
email Required String
Example
Request
POST
https://api.buddy.works/workspaces/buddy/members
{
  "email": "mike.benson@buddy.works"
}
Sample Response
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/member/1",
  "html_url": "https://app.buddy.works/buddy/profile/1",
  "id": 1,
  "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/171d78a3db9dc63368319ef4c9af9d9c/w/32/32/AVATAR.png",
  "title": null,
  "admin": false,
  "workspace_owner": false
}

Get workspace member

Returns a single workspace member. Non-admins must share the project with the fetched member or will get access denied.
Required scopes: WORKSPACE

Resource URL
GET
/workspaces/:domain/members/:member_id
URL Parameters
Name Description
domain Required String The workspace domain.
member_id Required Integer The numerical ID of the desired user.
Example
Request
GET
https://api.buddy.works/workspaces/buddy/members/1
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/member/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
}

Set administrator rights

Assigns admin rights to a user.
Required scopes: WORKSPACE

Resource URL
PATCH
/workspaces/:domain/members/:member_id
URL Parameters
Name Description
domain Required String The workspace domain.
member_id Required Integer The numerical ID of the desired user.
POST Parameters
Name Description
admin Boolean Specifies if the user is the workspace administrator.
Example
Request
PATCH
https://api.buddy.works/workspaces/buddy/members/1
{
  "admin": true
}
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/member/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 workspace member

Deletes a single workspace member. Restricted to admins only.
Required scopes: WORKSPACE

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

List user projects

Returns common user projects. Administrators will see all projects of the user.
Required scopes: WORKSPACE

Resource URL
GET
/workspaces/:domain/members/:member_id/projects
URL Parameters
Name Description
domain Required String The workspace domain.
member_id Required Integer The numerical ID of the desired user.
GET Parameters
Name Description
all Boolean Shows all user projects. Restricted to admins only.
page Integer The number of the successive page (results are splitted by pages of per_page elements each).
per_page Integer The number of returned elements on the page.
sort_by String Specifies ordering. Can be one of NAME, CREATED, SIZE or UPDATED.
sort_direction String Specifies direction of ordering. Can be one of ASC or DESC.
status String Filters projects down to the specified status. Can be one of ACTIVE or CLOSED.
Example
Request
GET
https://api.buddy.works/workspaces/buddy/members/1/projects?page=1&per_page=2&sort_by=name&sort_direction=ASC
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/workspaces/buddy/members/1/projects",
  "projects": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website",
      "html_url": "https://app.buddy.works/buddy/company-website",
      "name": "company-website",
      "display_name": "Company Website",
      "status": "ACTIVE"
    }
  ]
}