---
title: "Get a list of users"
method: GET
path: "/users"
tags: ["User Management"]
---

# Get a list of users

`GET /users`

## Query parameters

- `page` integer
- `per_page` integer
- `user_id` string, uuid4
- `email` string, email
- `sort_direction` 'asc' | 'desc'

## Response `200`

Details about users

- UserBase[]
  - `id` string, uuid4
  - `user_id` string, uuid4
  - `emails` object[]
    - `id` string, uuid4
    - `address` string, email — The email address
    - `is_verified` boolean — Indicated the email has been verified.
    - `is_primary` boolean — Indicates it's the primary email address.
    - `identity` object — Deprecated, use `user.identities` instead.
      - `id` string — The ID of the user at the provider
      - `identity_id` string, uuid4 — The identity's ID
      - `provider` string — Contains the display name of the provider, if available. Otherwise contains the provider ID.
    - `identities` Identity[] — Deprecated, use `user.identities` instead.
      - `id` string — The ID of the user at the provider
      - `identity_id` string, uuid4 — The identity's ID
      - `provider` string — Contains the display name of the provider, if available. Otherwise contains the provider ID.
  - `created_at` string, date-time — Time of creation of the the user
  - `updated_at` string, date-time — Time of last update of the user
  - `passkeys` WebauthnCredential[]
    - `aaguid` string, uuid
    - `attestation_type` 'none' | 'packed' | 'tpm' | 'android-key' | 'android-safetynet' | 'fido-u2f' | 'apple'
    - `backup_eligible` boolean
    - `backup_state` boolean
    - `created_at` string, date-time
    - `id` string, uuid
    - `last_used_at` string, date-time
    - `mfa_only` boolean
    - `name` string
    - `public-key` string
    - `transports` string[]
  - `security_keys` WebauthnCredential[]
    - `aaguid` string, uuid
    - `attestation_type` 'none' | 'packed' | 'tpm' | 'android-key' | 'android-safetynet' | 'fido-u2f' | 'apple'
    - `backup_eligible` boolean
    - `backup_state` boolean
    - `created_at` string, date-time
    - `id` string, uuid
    - `last_used_at` string, date-time
    - `mfa_only` boolean
    - `name` string
    - `public-key` string
    - `transports` string[]
  - `metadata` UserMetadata — The public and unsafe metadata of a user
    - `public_metadata` object
    - `unsafe_metadata` object
  - `name` string
  - `given_name` string
  - `family_name` string
  - `picture` string, uri
  - `mfa_config` object
    - `auth_app_set_up` boolean
    - `totp_enabled` boolean
    - `security_key_enabled` boolean

## Other responses

- `400` — Bad Request
- `500` — Internal server error

---

[API](https://skmtc.net/hanko/apis/hanko-admin-api.md) · [All operations](https://skmtc.net/hanko/apis/hanko-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hanko/hanko-admin-api/versions/d22a127b0978/schema)