latestOpenAPI 3.0.12026-08-064278250.7 KB

b635522b2393

portal-users

Retrieve portal users

Retrieve a list of admin portal users in a specified workspace. This call supports pagination; default page size includes 20 users.

get/v1/portal-users

Query parameters

pagestring

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

API responses use pagination to reduce loading time. Return a specific page of results, using a zero-based page index (0..N).

pageSizestring

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

API responses use pagination to reduce loading time. Return a maximum of this many items per page.

emailstring

Filter by an admin portal user's email address. This query is not case sensitive.

Filter by an admin portal user's email address. This query is not case sensitive.

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Response

Success

itemsPortalUsersResponse[] — unresolved $ref
totalElementsinteger

The total number of records that exist for the request.