# Get users

**GET /api/users**

Get users with filters and pagination.

Logto provides a very flexible way to query users. You can filter users by almost any fields with multiple modes. To learn more about the query syntax, please refer to [Advanced user search](https://docs.logto.io/docs/recipes/manage-users/advanced-user-search/).


## Servers
- Logto endpoint address.: https://[tenant_id].logto.app (Logto endpoint address.)


## Authentication methods
- O auth2


## Parameters


### Query parameters
- **page** (integer)
  Page number (starts from 1).
- **page_size** (integer)
  Entries per page.
- **search_params** (object)
  Search query parameters.


## Responses
### 200
An array of users that match the given criteria.

#### Body: application/json (array[object])
- **id** (string)

- **username** (string | null)

- **primaryEmail** (string | null)

- **primaryPhone** (string | null)

- **name** (string | null)

- **avatar** (string | null)

- **customData** (object)
  arbitrary
- **identities** (object)

- **lastSignInAt** (number | null)

- **createdAt** (number)

- **updatedAt** (number)

- **profile** (object)

- **applicationId** (string | null)

- **isSuspended** (boolean)

- **hasPassword** (boolean)

- **ssoIdentities** (array[object])


### 400
Bad Request

### 401
Unauthorized

### 403
Forbidden


[Powered by Bump.sh](https://bump.sh)