1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
documentation/content/en/methods/custom_emojis.md
trwnh ffbe66a389
Update content for 4.0, part 2 (#1060)
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
2022-12-14 22:55:30 +01:00

88 lines
2.4 KiB
Markdown

---
title: custom_emojis API methods
description: >-
Each site can define and upload its own custom emoji to be attached to
profiles or statuses.
menu:
docs:
weight: 30
name: custom_emojis
parent: methods-instance
identifier: methods-custom_emojis
aliases: [
"/methods/custom_emojis",
"/api/methods/custom_emojis",
"/methods/instance/custom_emojis"
]
---
<style>
#TableOfContents ul ul ul {display: none}
</style>
## View all custom emoji {#get}
```http
GET /api/v1/custom_emojis HTTP/1.1
```
Returns custom emojis that are available on the server.
**Returns:** Array of [CustomEmoji]({{< relref "entities/CustomEmoji" >}})\
**OAuth:** Public\
**Version history:**\
2.0.0 - added\
3.0.0 - optional `category` added to response
#### Response
##### 200: OK
Sample response from mastodon.social
```json
[
{
"shortcode": "aaaa",
"url": "https://files.mastodon.social/custom_emojis/images/000/007/118/original/aaaa.png",
"static_url": "https://files.mastodon.social/custom_emojis/images/000/007/118/static/aaaa.png",
"visible_in_picker": true
},
{
"shortcode": "AAAAAA",
"url": "https://files.mastodon.social/custom_emojis/images/000/071/387/original/AAAAAA.png",
"static_url": "https://files.mastodon.social/custom_emojis/images/000/071/387/static/AAAAAA.png",
"visible_in_picker": true
},
// [...]
{
"shortcode": "blobaww",
"url": "https://files.mastodon.social/custom_emojis/images/000/011/739/original/blobaww.png",
"static_url": "https://files.mastodon.social/custom_emojis/images/000/011/739/static/blobaww.png",
"visible_in_picker": true,
"category": "Blobs"
},
// [...]
{
"shortcode": "yikes",
"url": "https://files.mastodon.social/custom_emojis/images/000/031/275/original/yikes.png",
"static_url": "https://files.mastodon.social/custom_emojis/images/000/031/275/static/yikes.png",
"visible_in_picker": true
},
{
"shortcode": "ziltoid",
"url": "https://files.mastodon.social/custom_emojis/images/000/017/094/original/05252745eb087806.png",
"static_url": "https://files.mastodon.social/custom_emojis/images/000/017/094/static/05252745eb087806.png",
"visible_in_picker": true
}
]
```
---
## See also
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/custom_emojis_controller.rb" caption="app/controllers/api/v1/custom_emojis_controller.rb" >}}