List workspace members

workspace_admin.members.list(workspace_id, **kwargs) -> CursorPagination<WorkspaceMember { actor_id, profile_id, added_at, 2 more } >

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

Lists the members of a workspace. Admin only.

ParametersExpand Collapse

workspace_id: String

cursor: String

Pagination cursor from previous response

limit: Integer

Maximum number of results to return

formatint32

ReturnsExpand Collapse

class WorkspaceMember { actor_id, profile_id, added_at, 2 more }

A member of a workspace: the profile granted access plus the actor row that links it to the workspace. Returned by member list/add operations.

actor_id: String

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

profile_id: String

The account profile that has access to the workspace.

added_at: Time

When the member was added to the workspace.

formatdate-time

email: String

Email address of the member’s profile.

name: String

Display name of the member’s profile.

List workspace members

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.workspace_admin.members.list("workspaceId")

puts(page)

{
  "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
  }
}