FRfrontegg
User management

Get users

This route gets all users for a tenant OR environment. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant or leave it empty for all tenants' users

get/resources/users/v3

Request

Query parameters

_limitnumber

The default limit is 50 users per request, the maximum is 200

_includeSubTenantsboolean

when passing a user id, gives the option to include or not include sub tenants when searching users

_offsetnumber
_emailstring
_tenantIdstring
idsstring
_sortBy'createdAt' | 'name' | 'email' | 'id' | 'verified' | 'isLocked' | 'provider' | 'tenantId'
_order'ASC' | 'DESC'

Headers

frontegg-tenant-idstring

The tenant ID identifier

Response

idstring required
emailstring required
namestring
profilePictureUrlstring
substring required
verifiedboolean required
mfaEnrolledboolean required
mfaBypassboolean
phoneNumberstring
providerstring required
tenantIdstring required
tenantIdsstring[] required
activatedForTenantboolean
isLockedboolean
invisibleboolean
superUserboolean
metadatastring required
vendorMetadatastring required
createdAtstring date-time required
lastLoginstring date-time required
subAccountAccessAllowedboolean required
managedBy'frontegg' | 'scim2' | 'external'

Changes

No recorded changes to this operation across all 1 revision of this API.