---
title: "List users"
method: GET
path: "/users"
tags: ["Users"]
---

# List users

`GET /users`

Returns a list of project users.

The list supports pagination and sorting:
- The `sort` parameter only supports the `created` field (use `created` for ascending, `-created` for descending).
- Users can be filtered by:
  - Single user ID using `userID`
  - Multiple user IDs using `userIDs` (max 1000)
  - Multiple WebAuthn IDs using `webauthnIDs` (max 1000)
  - Single identifier using `identifierValue` and `identifierType` together
  - Multiple identifiers using `identifierValues` and `identifierType` together (max 1000)

Filtering rules:
- Only one filter type can be used at a time: `userID`, `userIDs`, `webauthnIDs`, or identifier filters
- `userID` and `userIDs` are mutually exclusive
- `identifierValue` and `identifierValues` are mutually exclusive
- When filtering by identifier(s), `identifierType` must be provided

## Query parameters

- `userID` string
- `userIDs` string[]
- `userIDPattern` string
- `webauthnIDs` string[]
- `identifierValue` string
- `identifierValues` string[]
- `identifierType` 'email' | 'phone' | 'username'
- `status` 'active' | 'pending' | 'disabled' | 'deleted'
- `sort` '+created' | '-created'
- `includeIdentifiers` boolean
- `page` integer
- `pageSize` integer

## Response `200`

List of users.

- UserList
  - `users` UserAggregate[], required
    - `userID` string, required
    - `fullName` string
    - `status` 'pending' | 'active' | 'disabled' | 'deleted', required
    - `explicitWebauthnID` string
    - `emailIdentifiers` Identifier[], required
      - `identifierID` string, required — Unique identifier of the login identifier.
      - `type` 'email' | 'phone' | 'username', required
      - `value` string, required — Value of the identifier (here email address).
      - `status` 'pending' | 'primary' | 'verified', required
      - `userID` string, required — Unique identifier of the user.
    - `phoneNumberIdentifiers` Identifier[], required
      - `identifierID` string, required — Unique identifier of the login identifier.
      - `type` 'email' | 'phone' | 'username', required
      - `value` string, required — Value of the identifier (here email address).
      - `status` 'pending' | 'primary' | 'verified', required
      - `userID` string, required — Unique identifier of the user.
    - `usernameIdentifiers` Identifier[], required
      - `identifierID` string, required — Unique identifier of the login identifier.
      - `type` 'email' | 'phone' | 'username', required
      - `value` string, required — Value of the identifier (here email address).
      - `status` 'pending' | 'primary' | 'verified', required
      - `userID` string, required — Unique identifier of the user.
    - `socialAccounts` SocialAccount[], required
      - `socialAccountID` string, required — Unique identifier of the social account.
      - `providerType` string, required — Type of the social provider.
      - `identifierValue` string, required — Login identifier of the user (here email address).
      - `userID` string, required — Unique identifier of the user.
      - `foreignID` string, required — Unique identifier of the user in the social provider.
      - `avatarURL` string, required — URL of the avatar of the user in the social provider.
      - `fullName` string, required — Full name of the user in the social provider.
    - `created` string, required
    - `createdMS` integer, required
    - `updated` string, required
    - `updatedMs` integer, required
  - `paging` object, required
    - `page` integer, required — current page returned in response
    - `totalPages` integer, required — total number of pages available
    - `totalItems` integer, required — total number of items available

## Other responses

- `default` — Error

---

[API](https://skmtc.dev/corbado/apis/corbado-backend-api.md) · [All operations](https://skmtc.dev/corbado/apis/corbado-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/corbado/corbado-backend-api/revisions/1f6143efe426/schema)