Get all custom emoji

Get all the custom emoji in the user's organization.

GET https://leanprover.zulipchat.com/api/v1/realm/emoji

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

result = client.get_realm_emoji()
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(async (client) => {
    return await client.emojis.retrieve();
}).then(console.log).catch(console.err);

curl -sSX GET -G https://leanprover.zulipchat.com/api/v1/realm/emoji \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • emoji: An object that contains emoji objects, each identified with their emoji ID as the key.

    • {emoji_id}: Object containing details about the emoji with the specified ID. It has the following properties:

      • id: The ID for this emoji, same as the object's key.

      • name: The user-friendly name for this emoji. Users in the organization can use this emoji by writing this name between colons (:name :).

      • source_url: The path relative to the organization's URL where the emoji's image can be found.

      • deactivated: Whether the emoji has been deactivated or not.

      • author_id: The user ID of the user who uploaded the custom emoji. Will be null if the uploader is unknown.

        Changes: New in Zulip 3.0 (feature level 7). Previously was accessible via and author object with an id field.

Example response

A typical successful JSON response may look like:

{
    "emoji": {
        "1": {
            "author_id": 5,
            "deactivated": false,
            "id": "1",
            "name": "green_tick",
            "source_url": "/user_avatars/1/emoji/images/1.png"
        }
    },
    "msg": "",
    "result": "success"
}