---
title: "View a user"
method: GET
path: "/v3/users/{user_id}"
tags: ["User"]
---

# View a user

`GET /v3/users/{user_id}`

## Request

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

## View a user

You can retrieve information about a user using this API.

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

`user_id`  
Type: string  
Description: Specifies the unique ID of the user to retrieve.

## Path parameters

- `user_id` string, required

## Query parameters

- `include_unread_count` boolean
- `custom_types` string
- `super_mode` 'all' | 'super' | 'nonsuper'

## Headers

- `api-token` string

## Response `200`

Successful response

- ViewAUserResponse: User
  - `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-07-27** `7a85bad03e90`: 1 breaking, 1 warning, 5 info
  - the `query` request parameter `super_mode` was restricted to a list of enum values
  - deleted the `header` request parameter `Api-Token`
  - api operation id `viewUserById` removed and replaced with `viewAUser`
  - added the new optional `header` request parameter `api-token`
  - …3 more
- **2023-11-10** `135d8b0705d4`: 1 info
  - the `header` request parameter `Api-Token` became optional
- **2022-02-16** `c42164095c7c`: 1 breaking
  - the `header` request parameter `Api-Token` became required
- **2022-02-10** `a6ec75cbd9fb`: 1 breaking, 12 warning
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `connection_status` from the response with the `200` status
  - removed the optional property `friend_discovery_key` from the response with the `200` status
  - removed the optional property `friend_name` from the response with the `200` status
  - …9 more

[Operation history](https://skmtc.dev/sendbird/apis/sendbird-platform-sdk/changes/v3/users/:user_id/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)