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

# List users

`GET /v3/users`

## Request

- Base URL: `https://api-APP_ID.sendbird.com`
- URL: `https://api-APP_ID.sendbird.com/v3/users`
- Auth: none declared

## List users

You can retrieve a list of users in your Sendbird application using this API. You can generate a customized list using various parameter combinations.

https://sendbird.com/docs/chat/platform-api/v3/user/listing-users/list-users#1-list-users

## Query parameters

- `token` string
- `limit` integer
- `active_mode` 'activated' | 'deactivated' | 'all'
- `show_bot` boolean
- `user_ids` string
- `nickname` string
- `nickname_startswith` string
- `metadatakey` string
- `metadatavalues_in` string

## Headers

- `api-token` string

## Response `200`

Successful response

- ListUsersResponse
  - `next` string
  - `users` SendbirdUser[]
    - `access_token` string
    - `created_at` integer
    - `discovery_keys` string[], nullable
    - `has_ever_logged_in` boolean
    - `is_active` boolean
    - `is_hide_me_from_friends` boolean
    - `is_online` boolean
    - `is_shadow_blocked` boolean
    - `last_seen_at` integer
    - `locale` string
    - `metadata` object, nullable
    - `nickname` string, nullable
    - `preferred_languages` string[], nullable
    - `profile_url` string
    - `require_auth_for_profile_image` boolean
    - `user_id` string, required
    - `state` '' | 'invited' | 'joined', nullable
    - `unread_channel_count` integer
    - `unread_message_count` integer
    - `phone_number` string
    - `is_created` boolean

## Changes

- **2025-10-17** `b05d4e3c6329`: 4 breaking, 1 warning, 1 info
  - the response property `users/items/discovery_keys` became nullable for the status `200`
  - the response property `users/items/metadata` became nullable for the status `200`
  - the response property `users/items/nickname` became nullable for the status `200`
  - the response property `users/items/preferred_languages` became nullable for the status `200`
  - …2 more
- **2025-07-27** `7a85bad03e90`: 2 breaking, 5 warning, 8 info
  - the `query` request parameter `active_mode` was restricted to a list of enum values
  - the `users/items/session_tokens/items/` response's property type changed from `object` to `string` for status `200`
  - deleted the `header` request parameter `Api-Token`
  - removed the optional property `users/items/description` from the response with the `200` status
  - …11 more
- **2024-09-24** `375ce8bc9c64`: 1 breaking
  - the response property `users/items/` became nullable for the status `200`
- **2023-11-10** `135d8b0705d4`: 1 info
  - the `header` request parameter `Api-Token` became optional
- **2022-10-10** `45e2df0efd62`: 1 breaking
  - the `users/items/session_tokens/items/` response's property type changed from `string` to `object` for status `200`

[Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/users/get.md)

---

[API](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk.md) - [All operations](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/llms.txt) - [OpenAPI document](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/revisions/9e53a5288df0?raw)