---
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

---

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