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 | Type | Description |
---|---|---|
domain Required | String | The workspace domain. |
GET Parameters
Name | Type | Description |
---|---|---|
page Integer | Integer | The number of the successive page (results are splitted by pages of per_page elements each). |
per_page Integer | Integer | The number of returned elements on the page. |
sort_by String | String | Specifies ordering. Can be one of email , name or short_name . |
sort_direction String | 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
HTTP
Status: 200 OKX-Rate-Limit-Limit: 1X-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","title": "Creative director"}]}