latestOpenAPI 3.0.22026-08-1041321430.0 KB

c88faa17bc25

user

List users

List users in the same workspace. Administrators & operators with legacyViewAll set to true can see the full list, other users can only see themselves.

get/users

Query parameters

pageinteger

Which page to fetch

pageSizeinteger

Page size to use

role'ADMIN' | 'OPERATOR' | 'READ_ONLY_API_KEY'

User role

deviceType'PSD' | 'SOFT_PSD' | 'API'

User's device type

status'ACTIVE' | 'INACTIVE'

User status

sortBy'name' | 'role' | 'status' | 'createdAt' | 'updatedAt'

Sort by attribute

sortOrder'asc' | 'desc'

Sort order

idsstring[]

List of user IDs to filter by

portfolioIdsstring[]

Filter users by portfolio membership

Response

Successful response

pagenumber required

Current page

nextnumber required

Next page or null if there is none

prevnumber required

Previous page or null if there is none

pageSizenumber required

Max count of items per page

totalnumber required

Total count of items