Get profile
Get the profile of the user/bot that requests this endpoint.
GET https://chat.virginvoyages.com/api/v1/users/me
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get the profile of the user/bot that requests this endpoint,
# which is `client` in this case:
result = client.get_profile()
print(result)
More examples and documentation can be found here.
const zulip = require('zulip-js');
// Pass the path to your zuliprc file here.
const config = {
zuliprc: 'zuliprc',
};
zulip(config).then((client) => {
// Get the profile of the user/bot that requests this endpoint,
// which is `client` in this case:
client.users.me.getProfile().then(console.log);
});
curl -X GET https://chat.virginvoyages.com/api/v1/users/me \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Arguments
This endpoint takes no arguments.
Response
Return values
pointer: The integer ID of the message that the pointer is currently on.max_message_id: The integer ID of the last message by the user/bot with
the given profile.
The rest of the return values are quite self-descriptive.
Example response
A typical successful JSON response may look like:
{
"client_id": "74c768b081076fdb3c4326256c17467e",
"email": "iago@zulip.com",
"full_name": "Iago",
"is_admin": true,
"is_bot": false,
"max_message_id": 30,
"msg": "",
"pointer": -1,
"result": "success",
"short_name": "iago",
"user_id": 5
}