Plum / developers
REST APIWorkspaces

List workspace members

Lists members with their email, name, and role, highest role first. Any member can list them; requires `workspace:read`. Returns every member; `cursor` is always null. A shared workspace's members need workspace sharing for your account; otherwise 403 `WORKSPACE_SHARING_REQUIRED`.

GET/workspaces/{id}/members

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/members" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "items": [      {        "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",        "email": "string",        "name": "string",        "role": "string",        "joined_at": "2019-08-24T14:15:22Z"      }    ],    "cursor": "string"  }}