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
User by userIdParameter
Accessible via URL https://api.channel.io/open/v4/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/v4/users/5ec3a01fe2b3f4d2cbc5
Response
Returns User object along with related information.
{
"user": {
"id": "string",
"channelId": "string",
"memberId": "string",
"veilId": "string",
"unifiedId": "string",
"name": "string",
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"profileOnce": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"tags": [
"string"
],
"alert": 0,
"unread": 0,
"popUpChatId": "string",
"blocked": true,
"unsubscribeEmail": true,
"unsubscribeTexting": true,
"hasChat": true,
"hasPushToken": true,
"language": "string",
"country": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"web": {
"device": "string",
"os": "string",
"osName": "string",
"browser": "string",
"browserName": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"mobile": {
"device": "string",
"os": "string",
"osName": "string",
"appName": "string",
"appVersion": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"sessionsCount": 0,
"lastSeenAt": 1624422361664,
"createdAt": 1624422361767,
"updatedAt": 1624422361664,
"version": 0,
"managedKey": 0,
"member": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"systemLanguage": "string"
},
"online": {
"channelId": "string",
"personType": "string",
"personId": "string",
"id": "string"
}
}
Get a particular User by memberId
User by memberIdParameter
Accessible via URL https://api.channel.io/open/v4/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/v4/users/@12345
Response
Returns User object along with related information.
{
"user": {
"id": "string",
"channelId": "string",
"memberId": "string",
"veilId": "string",
"unifiedId": "string",
"name": "string",
"profile": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"profileOnce": {
"name": "string",
"empty": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"tags": [
"string"
],
"alert": 0,
"unread": 0,
"popUpChatId": "string",
"blocked": true,
"unsubscribeEmail": true,
"unsubscribeTexting": true,
"hasChat": true,
"hasPushToken": true,
"language": "string",
"country": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"web": {
"device": "string",
"os": "string",
"osName": "string",
"browser": "string",
"browserName": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"mobile": {
"device": "string",
"os": "string",
"osName": "string",
"appName": "string",
"appVersion": "string",
"sessionsCount": 0,
"lastSeenAt": 1624422372181
},
"sessionsCount": 0,
"lastSeenAt": 1624422361664,
"createdAt": 1624422361767,
"updatedAt": 1624422361664,
"version": 0,
"managedKey": 0,
"member": true,
"email": "string",
"avatarUrl": "string",
"mobileNumber": "string",
"systemLanguage": "string"
},
"online": {
"channelId": "string",
"personType": "string",
"personId": "string",
"id": "string"
}
}
Updated about 1 year ago