Get all custom emoji

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

GET https://yourZulipDomain.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');

// Download zuliprc-dev from your dev server
const config = {
    zuliprc: 'zuliprc-dev',
};

zulip(config).then((client) => {
    return client.emojis.retrieve();
}).then(console.log);

curl https://yourZulipDomain.zulipchat.com/api/v1/realm/emoji \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Arguments

This endpoint does not consume any arguments.

Response

Return values

  • emoji: An object that contains emoji objects, each identified with their emoji ID as the key, and containing 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: An object describing the user who created the custom emoji, with the following fields:
      • id: The creator's user ID.
      • email: The creator's email address.
      • full_name: The creator's full name.

Example response

A typical successful JSON response may look like:

{
    "emoji": {
        "1": {
            "author": {
                "email": "iago@zulip.com",
                "full_name": "Iago",
                "id": 5
            },
            "deactivated": false,
            "id": "1",
            "name": "green_tick",
            "source_url": "/user_avatars/1/emoji/images/1.png"
        }
    },
    "msg": "",
    "result": "success"
}