List All Custom Emojis

Prev Next
Get
/api/v1/emoji-custom.all

List all custom emojis.

Changelog

Version Description
7.11.0 Added the name query parameter
0.63.0 Added
Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Query parameters
name
string

Enter the emoji name you want to find. This parameter is optional.

Exampleemoji-one
offset
integer

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
integer

The number of items to return. Refer to the official documentation to learn more.

Example50
Responses
200

OK

Example
{
  "emojis": [
    {
      "_id": "6542e83aa2f73c7460e18efb",
      "name": "happy",
      "aliases": [
        "happy-gang"
      ],
      "extension": "png",
      "_updatedAt": "2023-11-02T00:07:22.433Z"
    }
  ],
  "count": 1,
  "offset": 0,
  "total": 1,
  "success": true
}
Expand All
object
emojis
Array of object
object
_id
string
name
string
aliases
Array of string
string
extension
string
_updatedAt
string
count
integer
offset
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string