Get user

Prev Next

Available in Classic and VPC

Get user details.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /v1/api/members/{userId}

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
userId String Required User ID

Request example

The request example is as follows:

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/39c8de0f-****-****-****-6a1a875df59f' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - User ID
project_id String - Project ID
member_id String - User ID
name String - User name
profile String - User profile image
memo String - Note for user
country String - Country connected
remoteip String - Access IP address
adid String - Ad ID
device String - Device
network String - Network
version String - Version
model String - Model
deleted Boolean - Withdrawal status
  • true | false
    • true: Unsubscribed
    • false: Not unsubscribed
online Boolean - Online status
  • true | false
    • true: Online
    • false: Offline
customField String - User-defined field
device_type Array - Device type
push Boolean - Whether to allow push notifications
  • true | false
    • true: Allow
    • false: Block
memberblock_id String - TBD
notifications Object - Push notification information
notifications.token String - Push token
notifications.device String - Device push type
  • FCM | APNS
notifications.os String - Operating system version
notifications.push Boolean - Whether to allow push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.ad Boolean - Whether to allow ad push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.night Boolean - Whether to allow night push notifications
  • true | false
    • true: Allow
    • false: Block
notifications.timezone String - Time zone
logined_at String - Last login date and time
  • ISO 8601 format
created_at String - User registration date and time
  • ISO 8601 format
updated_at String - Information modification date and time
  • ISO 8601 format
deleted_at String - Withdrawal date and time
  • ISO 8601 format

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

{
    "id": "39c8de0f-****-****-****-6a1a875df59f",
    "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
    "member_id": "39c8de0f-****-****-****-6a1a875df59f",
    "name": "apitester",
    "profile": "",
    "memo": null,
    "country": "KR",
    "remoteip": "***.***.***.***",
    "adid": null,
    "device": null,
    "network": null,
    "version": null,
    "model": null,
    "deleted": false,
    "online": false,
    "customField": "",
    "device_type": [],
    "push": null,
    "memberblock_id": null,
    "notifications": {
        "token": "*********************************",
        "device": "APNS",
        "os": "iOS 18",
        "push": true,
        "ad": true,
        "night": true,
        "timezone": null
    },
    "logined_at": "2025-07-22T17:48:04+09:00",
    "created_at": "2025-07-22T11:11:05+09:00",
    "updated_at": "2025-07-22T17:48:04+09:00",
    "deleted_at": null
}