List workspace members

$ cadenya workspace-admin:members list

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

Lists the members of a workspace. Admin only.

ParametersExpand Collapse

--workspace-id: string

The workspace whose members will be listed (path).

--cursor: optional string

Pagination cursor from previous response

--limit: optional number

Maximum number of results to return

ReturnsExpand Collapse

ListWorkspaceMembersResponse: object { items, pagination }

items: optional array of WorkspaceMember { actorId, profileId, addedAt, 2 more }

actorId: string

The actor row linking the profile to the workspace (the junction record).

profileId: string

The account profile that has access to the workspace.

addedAt: optional string

When the member was added to the workspace.

email: optional string

Email address of the member’s profile.

name: optional string

Display name of the member’s profile.

pagination: optional object { nextCursor, total }

nextCursor: optional string

total: optional number

List workspace members

cadenya workspace-admin:members list \
  --api-key 'My API Key' \
  --workspace-id workspaceId

{
  "items": [
    {
      "actorId": "actorId",
      "profileId": "profileId",
      "addedAt": "2019-12-27T18:11:19.117Z",
      "email": "email",
      "name": "name"
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}

Returns Examples

{
  "items": [
    {
      "actorId": "actorId",
      "profileId": "profileId",
      "addedAt": "2019-12-27T18:11:19.117Z",
      "email": "email",
      "name": "name"
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}