Get

Get CometChat user details by UID with REST API, including profile fields, status, role, metadata, and tags.

GET /users/{uid}

Get

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/users/{uid} \
  --header 'apikey: <api-key>'

200

{
  "data": {
    "uid": "cometchat-uid-6",
    "name": "Barry Allen",
    "link": "https://cometchat.com",
    "avatar": "https://assets.cometchat.io/sampleapp/v2/groups/cometchat-guid-1.webp",
    "status": "offline",
    "role": "manager",
    "createdAt": 1638354015
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Headers

onBehalfOf · string

UID of the user on whose behalf the action is performed.

Path Parameters

uid · string · required

UID of the user on whose behalf the action is performed.

Response

200 - application/json

Fetched User

data · object