Skip to main content
GET
List workspace members
Back to the User Management APIs overview You can list the members of a workspace using this endpoint. The request needs the workspace.members.read scope. You can filter the list by status, roleId, emails, externalId, and updatedSince. To filter by email address, use Search workspace members so addresses stay out of URLs. Results are paginated with a cursor. Pass nextCursor from the response as cursor in the next request. A cursor works only with the filters it was issued for. Set include to projects to return each member’s project memberships. The maximum limit is then 50. The status filter takes up to six values: active, pending, expired, suspended, deactivated, and locked. The pending and expired statuses are invitations that grant no access. Use limit to set the page size from 1 to 200. The default is 50.

Authorizations

X-API-Key
string
header
required

Platform key, for example abl_ws_….

Path Parameters

workspaceId
string
required
Minimum string length: 1

Query Parameters

status
enum<string>[]
Maximum array length: 6
Available options:
active,
pending,
expired,
suspended,
deactivated,
locked
roleId
string
Required string length: 1 - 256
emails
string<email>[]
Maximum array length: 50
Maximum string length: 254
externalId
string
Maximum string length: 256
updatedSince
string<date-time>
include
enum<string>
Available options:
projects
limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string
Maximum string length: 2048

Response

Success

success
enum<boolean>
required
Available options:
true
data
object
required