Skip to navigation
API ReferenceWorkspaces

List workspace memberships

Beta

The full membership roster of one workspace with each member’s user id, name, email, role and join date — built for usage reporting and licence reconciliation, unlike the share-picker search at GET /workspaces/{workspace_id}/members. Removed members are left out unless include_archived=true. Pages are ordered by user id; next_cursor is returned while more remain. Requires workspace owner or manager (or Athena admin) permissions.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

workspace_idstringRequired
Unique identifier of the workspace

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

include_archivedbooleanOptionalDefaults to false
Also return memberships that were removed from the workspace
cursorstring or nullOptional

next_cursor from the previous page

limitintegerOptional1-500Defaults to 200
Maximum memberships per page

Response

One page of memberships
membershipslist of objects
Memberships for this page, ordered by user id
next_cursorstring or null

Pass as cursor to fetch the next page; null on the last page

workspace_idstring
Workspace the roster belongs to

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error