---
title: "List Emoji Directory records"
method: GET
path: "/v1/data/emoji-directory"
tags: ["Emoji"]
---

# List Emoji Directory records

`GET /v1/data/emoji-directory`

## Request

- Base URL: `https://api.aristocles.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.aristocles.com.au/v1/data/emoji-directory`
- Auth: none declared. Required headers: `X-API-Key`

List Emoji Directory records with optional filters and pagination.

**Source:** Emoji data from GitHub gemoji (MIT License) (MIT).

**Fields returned:**
- `emoji` (str) — The emoji character itself
- `description` (str) — Plain-English name of the emoji
- `category` (str) — Emoji category such as Smileys & Emotion or Food & Drink
- `unicode_version` (str) — Unicode version that introduced the emoji
- `ios_version` (str) — iOS version that first supported the emoji

**Example:** `GET /v1/data/emoji-directory?limit=10&category=example`

## Query parameters

- `limit` integer: Max records to return (1-100).
- `offset` integer: Records to skip, for pagination.
- `category` string, nullable: Emoji category such as Smileys & Emotion or Food & Drink
- `unicode_version` string, nullable: Unicode version that introduced the emoji

## Headers

- `X-API-Key` string, required

## Response `200`

A page of Emoji Directory records with pagination metadata.

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/aristocles/apis/aristocles-data-api.md) · [All operations](https://skmtc.dev/aristocles/apis/aristocles-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aristocles/apis/aristocles-data-api/revisions/4ca3fbb73c59?raw)
