PermuteDocs
Go to Permute

Memberships · workspaceMembersList

List workspace members

Lists direct workspace members and the workspace owner. Requires current workspace administration. CLI logins require admin access to all resources in the approved scope.

GET/v1/workspaces/{workspaceId}/members
betaplatformUserworkspace

When to use

Find people with direct memberships in the selected workspace, including its owner.

For agents

The list shows membership roles. Use permission inspection to check effective access to an individual resource.

Example

typescript
import { OAuthLogin } from '@permute/sdk/auth';

const client = await new OAuthLogin().client();
const result = await client.workspaceMembers.list('wksp_finance123');

Response

json
{
  "data": {
    "items": [
      {
        "userId": "user_example",
        "name": "Ada",
        "email": "ada@example.com",
        "organizationRole": "admin",
        "workspaceRole": "member"
      }
    ]
  }
}