mirror of https://github.com/zulip/zulip.git
60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# Get profile
|
|
|
|
Get basic data about the user/bot that requests this endpoint.
|
|
|
|
`GET {{ api_url }}/v1/users/me`
|
|
|
|
## Usage examples
|
|
|
|
{start_tabs}
|
|
{tab|python}
|
|
|
|
{generate_code_example(python)|/users/me:get|example}
|
|
|
|
{tab|js}
|
|
|
|
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
|
|
```js
|
|
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);
|
|
});
|
|
```
|
|
|
|
{tab|curl}
|
|
|
|
``` curl
|
|
curl -X GET {{ api_url }}/v1/users/me \
|
|
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
|
|
```
|
|
|
|
{end_tabs}
|
|
|
|
## 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:
|
|
|
|
{generate_code_example|/users/me:get|fixture(200)}
|