Sendbird/viewAUser

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

GET/v3/users/{user_id}

View a user

Retrieves information about a user by user_id, returning the user's resource representation including attributes such as nickname and profile image.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId: viewAUser
Server: https://api-{app_id}.sendbird.com
Authentication: apiTokenAuth

Request parameters

`user_id`

pathstringrequired

User identifier.

user_id_123

`include_unread_count`

queryboolean

include unread count field.

true

`custom_types`

querystring

custom types field.

custom_types_value

`super_mode`

querystring

Super channel mode.

all

Responses

`200`

SendbirdUserapplication/json

Request succeeded.

Properties: access_tokencreated_atdiscovery_keyshas_ever_logged_inis_activeis_createdis_hide_me_from_friendsis_onlineis_shadow_blockedlast_seen_atlocalemetadatanicknamephone_numberpreferred_languagesprofile_urlrequire_auth_for_profile_imagestateunread_channel_countunread_message_countuser_id

`400`

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

`401`

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

`403`

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

`404`

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

`429`

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

`500`

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "access_token": "next_page_token_abc",
  "created_at": 1,
  "discovery_keys": [
    "discovery_keys_value"
  ],
  "has_ever_logged_in": true,
  "is_active": true,
  "is_created": true,
  "is_hide_me_from_friends": true,
  "is_online": true
}