# Get users

Retrieve all users for an account (tenant) or for the entire environment.

Endpoint: GET /resources/users/v3
Security: bearer

## Query parameters:

  - `_limit` (number)
    The default limit is 50 users per request, the maximum is 200

  - `_identifier` (string)
    Filter users by username prefix match. Must be provided together with _identifierType

  - `_identifierType` (string)
    Filter users by username. Must be provided together with _identifier
    Enum: "email", "phoneNumber", "username"

  - `_includeSubTenants` (boolean)
    when passing a user id, gives the option to include or not include sub accounts (tenants) when searching users

  - `_namePrefix` (string)
    Filter users by prefix name match

  - `_offset` (number)
    The page number to retrieve. For example, use 0 for the first page, 1 for the second page.

  - `_email` (string)

  - `_tenantId` (string)

  - `ids` (string)

  - `_sortBy` (string)
    Enum: "createdAt", "name", "email", "id", "verified", "isLocked", "provider", "tenantId"

  - `_order` (string)
    Enum: "ASC", "DESC"

  - `_externalIds` (string)

## Header parameters:

  - `frontegg-tenant-id` (string)
    The account (tenant) ID identifier

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string, required)

  - `items.email` (string, required)

  - `items.name` (string, required)

  - `items.profilePictureUrl` (string, required)

  - `items.sub` (string, required)

  - `items.verified` (boolean, required)

  - `items.mfaEnrolled` (boolean, required)

  - `items.mfaBypass` (boolean)

  - `items.phoneNumber` (string)

  - `items.provider` (string, required)

  - `items.tenantId` (string, required)

  - `items.tenantIds` (array, required)

  - `items.activatedForTenant` (boolean)

  - `items.isLocked` (boolean)

  - `items.tenants` (array, required)

  - `items.tenants.roles` (array, required)

  - `items.tenants.roles.vendorId` (string, required)

  - `items.tenants.roles.key` (string, required)

  - `items.tenants.roles.description` (string, required)

  - `items.tenants.roles.isDefault` (boolean, required)

  - `items.tenants.roles.firstUserRole` (boolean, required)

  - `items.tenants.roles.level` (number, required)

  - `items.tenants.roles.createdAt` (string, required)

  - `items.tenants.roles.updatedAt` (string, required)

  - `items.tenants.roles.permissions` (array, required)

  - `items.tenants.temporaryExpirationDate` (string)

  - `items.tenants.isDisabled` (boolean)

  - `items.invisible` (boolean)

  - `items.superUser` (boolean)

  - `items.metadata` (string, required)

  - `items.vendorMetadata` (string, required)

  - `items.externalId` (string)

  - `items.lastLogin` (string, required)

  - `items.subAccountAccessAllowed` (boolean, required)

  - `items.managedBy` (string)
    Enum: "frontegg", "scim2", "external"

  - `_links` (object)

  - `_links.next` (string, required)

  - `_links.prev` (string, required)

  - `_links.first` (string, required)

  - `_links.last` (string, required)

  - `_metadata` (object)

  - `_metadata.totalItems` (number, required)

  - `_metadata.totalPages` (number, required)