List

Workspace members

Returns a list of users in the workspace. Administrators get a list of all users in the workspace, non-admin users get a list of their co-workers.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/members

URL Parameters

GET Parameters

Example

Request

GET https://api.buddy.works/workspaces/buddy/members?page=1&per_page=2&sort_by=name&sort_direction=ASC

Sample Response

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

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

User projects

Returns a list of projects of the specified user. Administrators get a list of all projects of the user, non-admin users get a list of the projects they share with the specified user.

Required scopes: WORKSPACE

Resource URL

GET /workspaces/:domain/members/:member_id/projects

URL Parameters

GET Parameters

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

HTTP

Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

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