Get profile

Get basic data about the user/bot that requests this endpoint.

GET https://yourZulipDomain.zulipchat.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 -sSX GET -G https://yourZulipDomain.zulipchat.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:

{
    "avatar_url": "https://secure.gravatar.com/avatar/af4f06322c177ef4e1e9b2c424986b54?d=identicon&version=1",
    "client_id": "74c768b081076fdb3c4326256c17467e",
    "email": "iago@zulip.com",
    "full_name": "Iago",
    "is_admin": true,
    "is_bot": false,
    "max_message_id": 30,
    "msg": "",
    "pointer": -1,
    "profile_data": {
        "1": {
            "rendered_value": "<p>+1-234-567-8901</p>",
            "value": "+1-234-567-8901"
        },
        "2": {
            "rendered_value": "<p>Betrayer of Othello.</p>",
            "value": "Betrayer of Othello."
        },
        "3": {
            "rendered_value": "<p>Apples</p>",
            "value": "Apples"
        },
        "4": {
            "value": "emacs"
        },
        "5": {
            "value": "2000-1-1"
        },
        "6": {
            "value": "https://zulip.readthedocs.io/en/latest/"
        },
        "7": {
            "value": "[10]"
        },
        "8": {
            "value": "zulip"
        }
    },
    "result": "success",
    "short_name": "iago",
    "user_id": 5
}