logo
Use this method to get a user’s profile. On success, the User is returned.
Field
Type
Required
Description
method
String
Yes
"getUser"
app_id
String
Yes
Unique identifier for App.
user_id
String
Yes
Unique identifier for this User or Bot.
reference
String
Optional
Unique identifier for the request. This reference will be echoed in the response.

Preconditions for API Functionality

The following table outlines the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.
Condition
API must have “Manage Users” permission
The API needs “Manage Users” permission to manage chats within the app.

Response:

userDetails

✅ On success, the userDetails method is returned with an echo of the user object.
Field
Type
Returned
Description
method
String
Yes
"userDetails"
app_id
String
Yes
Unique identifier for App.
user
Yes
User Object.
reference
String
Optional
Unique identifier echoed from the request.

Examples:

Requests

json
{ "method": "getUser", "app_id": "90090684293000559", "user_id": "90089584781491899", "reference": "132456789" }
java
// The object will be received in the onReceive callback. else if(text.equals("getUser")){ api.getUser(incomingMsg.getFrom().getId()); }
javascript
api.getUser(user.id);
python
napi.get_user("UserId")

Response

json
{ "method": "userDetails", "user": { "image": "\/9j\/4AAQSkZJRgABAQAASABIAAD\/4QCARXhpZgAATU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAKgAgAEAAAAAQAAAFygAwAEAAAAAQAAAFwAAAAA\/+0AOFBob3Rvc2hvcCAzLjAAOEJJTQQEAAAAAAAAOEJJTQQlAAAAAAAQ1B2M2Y8AsgTpgAmY7PhCfv\/AABEIAFwAXAMBIgACEQEDEQH\/xAAfAAABBQEBAQEBAQAAAAAAAAAAAQIDBAUGBwgJCgv\/xAC1EAACAQMDAgQDBQUEBAAAAX0BAgMABBEFEiExQQYTUWEHInEUMoGRoQgjQrHBFVLR8CQzYnKCCQoWFxgZGiUmJygpKjQ1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4eLj5OXm5+jp6vHy8\/T19vf4+fr\/xAAfAQADAQEBAQEBAQEBAAAAAAAAAQIDBAUGBwgJCgv\/xAC1EQACAQIEBAMEBwUEBAABAncAAQIDEQQFITEGEkFRB2FxEyIygQgUQpGhscEJIzNS8BVictEKFiQ04SXxFxgZGiYnKCkqNTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqCg4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2dri4+Tl5ufo6ery8\/T19vf4+fr\/2wBDAA8PDw8PDxoPDxokGhoaJDEkJCQkMT4xMTExMT5LPj4+Pj4+S0tLS0tLS0taWlpaWlppaWlpaXZ2dnZ2dnZ2dnb\/2wBDARITEx4cHjQcHDR7VEVUe3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3t7e3v\/3QAEAAb\/2gAMAwEAAhEDEQA\/AOCooo5pgFFHNHNABRRzRzQAUUc0c0AFFHNHNABSGl5pKAP\/0OGij8w7QQOM81JNbyQAM+MHgYNV6M0wCiiigAooooAKKKKACiiigApDS0h5oA\/\/0eCoqxazeRJvPQqw6A8kcdfetL7VpzACSPPTPHUjPJ59xTAxaKc+0uSgwuTge1NoAKKKKACiiigAooooAKQ8UtIaAP\/S4iEwgnzgSMcY9alD2eSSjY4wM+3+NVKKYFtXswCGjY88HPamh7UOTsYoR0zyPxqtRQBPK1uwHkoVOTnJzxUFFFABRRRQAUUUUAFIaWkNAH\/\/0+Coq5DEZTgHGB\/XHapjZTjqB+dMDNoq+1vIjbHwDgnr6DPaq9AEFFT0UAQUVPRQBBRU9FAEFJjNWKifrQB\/\/9TilJXlTj6U4ySE5LHP1qa0hWeTy3JA2sePYZqFFDKxP8Iz+oFMBuT60lT28SzSbGyBtY8ewJqCgAooooAKKKKACiiigAqJ+tS1E\/WgD\/\/Z", "name": "Donald Trump", "photo": { "thumbnail": { "width": 120, "id": "V_0F9o_90089584766094863_0_g0LwjLXs6x.jpg.thumb.jpg", "height": 120 }, "width": 256, "id": "V_0F9o_90089584766094863_0_g0LwjLXs6x.jpg", "height": 256 }, "id": "90089584766094863", "is_bot": false, "version": "0F9o", "status": "" } }