Get a single User

Get a particular User object.
You can get a particular user in two ways.
First way is retrieve a user by userId (User identifier in channel talk server).
Second is retrieve a user by memberId (User memberId that you used in plugin integration.

Get a particular User by userId

Parameter

Accessible via URL https://api.channel.io/open/v3/users/{userId} and HTTP GET

Parameter

Example

Required

Description

Parameter type

userId

5ec3a01fe2b3f4d2cbc5

Required

ID of User

Path

Example

GET https://api.channel.io/open/v3/users/5ec3a01fe2b3f4d2cbc5

Response

Returns User object along with related information.

{
  "user": {
    "id": "String",
    "channelId": "String",
    "memberId": "String",
    "veilId": "String",
    "name": "String",
    "alert": Integer,
    "unread": Integer,
    "blocked": Boolean,
    "unsubscribed": Boolean,
    "hasChat": Boolean,
    "hasPushToken": Boolean,
    "language": "String",
    "country": "String",
    "city": "String",
    "latitude": Long,
    "longitude": Long,
    "web": {
      "device": "String",
      "os": "String",
      "osName": "String",
      "browser": "Chrome 80.0.3987.132",
      "browserName": "Chrome",
      "sessionsCount": 5,
      "lastSeenAt": 1584673657636
    },
    "sessionsCount": Integer,
    "lastSeenAt": 1584673657636,
    "createdAt": 1584145649408,
    "updatedAt": 1584934318716,
    "version": Integer,
    "member": Boolean,
    "contact": Boolean,
    "avatarUrl": "String",
    "systemLanguage": "String"
  }
}

Get a particular User by memberId

Parameter

Accessible via URL https://api.channel.io/open/v3/users/@{memberId} and HTTP GET

Parameter

Example

Required

Description

Parameter type

memberId

12345

Required

memberId of User

Path

Example

GET https://api.channel.io/open/v3/users/@12345

Response

Returns User object along with related information.

{
  "user": {
    "id": "String",
    "channelId": "String",
    "memberId": "String",
    "veilId": "String",
    "name": "String",
    "alert": Integer,
    "unread": Integer,
    "blocked": Boolean,
    "unsubscribed": Boolean,
    "hasChat": Boolean,
    "hasPushToken": Boolean,
    "language": "String",
    "country": "String",
    "city": "String",
    "latitude": Long,
    "longitude": Long,
    "web": {
      "device": "String",
      "os": "String",
      "osName": "String",
      "browser": "Chrome 80.0.3987.132",
      "browserName": "Chrome",
      "sessionsCount": 5,
      "lastSeenAt": 1584673657636
    },
    "sessionsCount": Integer,
    "lastSeenAt": 1584673657636,
    "createdAt": 1584145649408,
    "updatedAt": 1584934318716,
    "version": Integer,
    "member": Boolean,
    "contact": Boolean,
    "avatarUrl": "String",
    "systemLanguage": "String"
  }
}