FRfrontegg
User management

Get users with fuzzy search

This route retrieves all users for a specific tenant or environment. To filter by tenant, include the tenant's ID in the frontegg-tenant-id header; otherwise, leave it empty to retrieve users from all tenants. In addition to all standard Get users query params, this route supports phrase search, allowing for complex queries using parameters such as contains, excludes, optional and approximate matching.

get/resources/users/v1/query/phrase

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

_phraseSearchContainsstring[]

Pass a list of strings, separated by comma, to search for users that contain all of the strings in the list

_phraseSearchExcludesstring[]

Pass a list of strings, separated by comma, to search for users that do not contain any of the strings in the list

_phraseSearchOptionalstring[]

Pass a list of strings, separated by comma, to search for users that contain at least one of the strings in the list

_phraseSearchApproximateboolean

When true, the search will be approximate (fuzzy), meaning it will include similar characters to the ones in the search string

_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.