/api/user

GET /api/user/

Fetch a list of Users for admins or group managers. By default returns only active users for admins and only active users within groups that the group manager is managing for group managers.

  • If status is deactivated, include deactivated users only.

  • If status is all, include all users (active and inactive).

  • Also supports include_deactivated, which if true, is equivalent to status=all; If is false, is equivalent to status=active. status and include_deactivated requires superuser permissions.

  • include_deactivated is a legacy alias for status and will be removed in a future release, users are advised to use status for better support and flexibility.

If both params are passed, status takes precedence.

  • if a tenant_id is passed, only users with that tenant_id will be returned.

For users with segmented permissions, return only themselves.

Takes limit, offset for pagination.

Takes query for filtering on first name, last name, email.

Also takes group_id, which filters on group id.

get/api/user/

Query parameters

statusstring nullable
querystring nullable
group_idinteger nullable

value must be an integer greater than zero.

include_deactivatedboolean nullable required
tenancy'all' | 'internal' | 'external' nullable
tenant_idinteger nullable

value must be an integer greater than zero.

Response

Successful response

Changes