List users

List users matching the specified criteria. Provide userIDs to look up specific users, or tenantID to list all users with access to an organization. If both are provided, tenantID takes precedence.

When includeSettings is true, each user object includes the nested tenantSettings containing notification preferences, dashboard preferences, recommendation filters, and display settings for the specified tenant.

Alternatively, provide reportOwnerCandidatesInTenantID or dashboardOwnerCandidatesInTenantID (checked before userIDs/tenantID) to list the members eligible to become a report's or dashboard's owner in that tenant. This mode requires the corresponding TRANSFER_*_OWNERSHIP permission and returns the minimal { candidates } projection instead of { users }.

Directory access is separate from single-profile access: userIDs requires system-wide user-read permission or partner user-read permission restricted to users associated with the same MSP. A tenant directory requires user-read permission scoped to that tenant. Listing a user does not grant permission to read or edit their profile through /users/USERID.

Query Params
userIDs
array of uuids

Used only when neither owner-candidate selector nor tenantID is supplied. Selector precedence is reportOwnerCandidatesInTenantID, dashboardOwnerCandidatesInTenantID, tenantID, then userIDs.

userIDs
uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

boolean

Include user tenant settings in the response

uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Return eligible report-owner candidates for this tenant instead of users. Requires TRANSFER_REPORT_OWNERSHIP; takes precedence over userIDs/tenantID and yields the { candidates } response.

uuid
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Return eligible dashboard-owner candidates for this tenant instead of users. Requires TRANSFER_DASHBOARD_OWNERSHIP; takes precedence over userIDs/tenantID and yields the { candidates } response.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json