List custom emojis

Retrieves a list of custom emojis in the workspace.

GET /v1/custom_emojis

TypeScript SDK

JavaScript

import { Client } from "@notionhq/client"
import { collectPaginatedAPI } from "@notionhq/client"

const notion = new Client()

// Single page
const response = await notion.customEmojis.list()

// All pages with pagination helper
const allEmojis = await collectPaginatedAPI(
  notion.customEmojis.list,
  {}
)

curl --request GET \
  --url https://api.notion.com/v1/custom_emojis \
  --header 'Authorization: Bearer <token>' \
  --header 'Notion-Version: <notion-version>'

import requests

url = "https://api.notion.com/v1/custom_emojis"

headers = {
    "Notion-Version": "<notion-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.notion.com/v1/custom_emojis",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Notion-Version: <notion-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.notion.com/v1/custom_emojis"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Notion-Version", "<notion-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.notion.com/v1/custom_emojis")
  .header("Notion-Version", "<notion-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.notion.com/v1/custom_emojis")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Notion-Version"] = '<notion-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "object": "<string>",
  "type": "<string>",
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "object": "<unknown>",
  "message": "<string>",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "unauthorized",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "restricted_resource",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "row_limit_exceeded",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "conflict_error",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "rate_limited",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "internal_server_error",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "service_unavailable",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "gateway_timeout",
  "status": "<unknown>",
  "additional_data": {}
}

{
  "object": "<unknown>",
  "message": "<string>",
  "code": "service_overload",
  "status": "<unknown>",
  "additional_data": {}
}

See Pagination for details about how to use a cursor to iterate through the list.

Use the name query parameter to filter by exact name match, which is useful for resolving a custom emoji name to its ID.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Notion-Version · enum<string> · required

The API version to use for this request. The latest version is 2026-03-11.

Available options: 2026-03-11

Query Parameters

start_cursor · string

If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results.

page_size · integer

The number of items from the full list desired in the response. Maximum: 100

Required range: 1 <= x <= 100

name · string

If supplied, filters custom emojis by exact name match. Useful for resolving a custom emoji name to its ID.

Response

200

application/json

object · string · required

Always list

Allowed value: "list"

type · string · required

Always custom_emoji

Allowed value: "custom_emoji"

results · object[] · required

The list of custom emojis.

Maximum array length: 100

Show child attributes

has_more · boolean · required

Whether there are more results available.

next_cursor · string<uuid> | null · required

The cursor to use for the next page of results, or null if there are no more results.