---
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` UserDetail[]
    - `id` number
    - `authId` string
    - `email` string, nullable
    - `socialAccountId` string, nullable
    - `socialAccountType` string, nullable
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `locale` string
    - `emailVerified` boolean
    - `otpVerified` boolean
    - `smsPhoneNumberVerified` boolean
    - `isActive` boolean
    - `createdAt` string
    - `updatedAt` string
    - `deletedAt` string, nullable
    - `roles` string[], nullable
  - `count` integer — Total number of users matching the query

## Changes

- **2024-09-26** `192da8a641d0` — 1 info
  - added the optional property `users/items/allOf[#/components/schemas/User]/smsPhoneNumberVerified` to the response with the `200` status
- **2024-09-17** `1f092af5030c` — 1 warning, 2 info
  - removed the optional property `users/items/allOf[#/components/schemas/User]/googleId` from the response with the `200` status
  - added the optional property `users/items/allOf[#/components/schemas/User]/socialAccountId` to the response with the `200` status
  - added the optional property `users/items/allOf[#/components/schemas/User]/socialAccountType` to the response with the `200` status
- **2024-08-18** `131e51c870ea` — 1 info
  - added the new optional `query` request parameter `search`
- **2024-08-18** `6c0a71f4107a` — 1 info
  - added the optional property `users/items/allOf[#/components/schemas/User]/googleId` to the response with the `200` status
- **2024-08-14** `3c591337acf2` — 1 info
  - added the optional property `users/items/allOf[#/components/schemas/User]/otpVerified` to the response with the `200` status

[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.dev/valuemelody/apis/melody-auth-s2s-api/revisions/ffd604cd7944?raw)