---
title: "Get a list of users"
method: GET
path: "/api/v1/users"
tags: ["Users"]
---

# Get a list of users

`GET /api/v1/users`

Required scope - read_user

## Query parameters

- `page_size` integer
- `page_number` integer
- `search` string

## Response `200`

A list of users

- object
  - `users` User[]
    - `id` number, required
    - `authId` string, required
    - `email` string, nullable, required
    - `linkedAuthId` string, nullable
    - `socialAccountId` string, nullable, required
    - `socialAccountType` string, nullable, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `locale` string, required
    - `loginCount` number, required
    - `mfaTypes` string[], required
    - `emailVerified` boolean, required
    - `otpVerified` boolean, required
    - `smsPhoneNumberVerified` boolean, required
    - `isActive` boolean, required
    - `isInviting` boolean, required
    - `invitationExpiresAt` string, nullable
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable, required
  - `count` integer — Total number of users matching the query

## Changes

- **2026-04-06** `74c633c2da2c` — 1 info
  - added the optional property `users/items/invitationExpiresAt` to the response with the `200` status
- **2026-04-05** `e8542f1e3a76` — 1 info
  - added the required property `users/items/isInviting` to the response with the `200` status
- **2025-01-28** `50ad4103f227` — 1 breaking, 19 info
  - the `users/items/` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `users/items/linkedAuthId` to the response with the `200` status
  - removed `#/components/schemas/User, subschema #2` from the `users/items/` response property `allOf` list for the response status `200`
  - added the required property `users/items/authId` to the response with the `200` status
  - …16 more
- **2024-12-10** `1956019598a7` — 1 info
  - added the optional property `users/items/allOf[#/components/schemas/User]/linkedAuthId` to the response with the `200` status
- **2024-10-03** `795cad873b47` — 18 info
  - the response property `users/items/allOf[#/components/schemas/User]/authId` became required for the status `200`
  - the response property `users/items/allOf[#/components/schemas/User]/createdAt` became required for the status `200`
  - the response property `users/items/allOf[#/components/schemas/User]/deletedAt` became required for the status `200`
  - the response property `users/items/allOf[#/components/schemas/User]/email` became required for the status `200`
  - …14 more

[Full history](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api/changes/api/v1/users/get.md)

---

[API](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api.md) · [All operations](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/valuemelody/melody-auth-s2s-api/revisions/2e1471620fd7/schema)