zulip/templates/zerver/api/get-org-emoji.md

50 lines
876 B
Markdown

# Get all custom emoji
{generate_api_description(/realm/emoji:get)}
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/realm/emoji: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) => {
return client.emojis.retrieve();
}).then(console.log);
```
{tab|curl}
{generate_code_example(curl)|/realm/emoji:get|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/realm/emoji:get}
## Response
#### Return values
{generate_return_values_table|zulip.yaml|/realm/emoji:get}
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/realm/emoji:get|fixture(200)}