API Docs / Operations / Users / List TenantUsers

List TenantUsers

GET /api/tenants/{tenant}/users

Lists all TenantUsers for the given tenant.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

search query string

Search across user code, first name, last name, and email (minimum 3 characters)

Search across user code, first name, last name, and email (minimum 3 characters)

status query string

Filter by user status (Created, Invited, Active, Disabled, Declined)

Filter by user status (Created, Invited, Active, Disabled, Declined)

isClientManager query boolean

Filter by client manager status (true = managers only, false = non-managers only)

Filter by client manager status (true = managers only, false = non-managers only)

isPartner query boolean

Filter by partner status (true = partners only, false = non-partners only)

Filter by partner status (true = partners only, false = non-partners only)

systemRole query string

Filter by system role (Admin, Manager, User, Viewer)

Filter by system role (Admin, Manager, User, Viewer)

isAssociate query boolean

Filter by associate status (true = associates only, false = non-associates only)

Filter by associate status (true = associates only, false = non-associates only)

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

LastName FirstName Email

Field to sort by.

LastName FirstName Email

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

401 Unauthorized - Invalid or missing API key

Try it