Workspace Members

  • GET
  • /workspaces
  • /:domain
  • /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.

Request

REQUIRED SCOPES
WORKSPACE
URL PARAMETERS
domainrequired string
The workspace domain.
GET PARAMETERS
pageinteger
The number of the successive page (results are splitted by pages of per_page elements each).
per_pageinteger
The number of returned elements on the page.
sort_bystring
Specifies ordering. Can be one of name (default) or id.
sort_directionstring
Specifies the direction of ordering. Can be one of ASC or DESC.

Last modified on Sep 25, 2024

Example:

CURL
curl -X GET "https://api.buddy.works/workspaces/:domain/members" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "Content-Type: application/json" \
EXAMPLE RESPONSE
{ "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" } ] }
STATUS
200 OK
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999