The GitHub Emojis API is a simple REST endpoint (GET /emojis or https://api.github.com/emojis) that returns a JSON dictionary mapping emoji shortcodes (like "smile" or "octocat") to the image URLs GitHub uses to render them. It covers both standard Unicode emoji and GitHub-specific custom ones, enabling clients to power emoji pickers, autocomplete for :shortcodes:, validation, or server-side rendering in apps that mirror GitHubs formatting.
openapi: 3.0.3
info:
version: 1.1.4
title: GitHub Emojis API
description: |-
Use the REST API to list and view all the available emojis to use on
GitHub.
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact?tags=dotcom-rest-api
x-github-plan: ghes
x-github-release: 3.9
tags:
- name: Emojis
- name: Get
servers:
- url: '{protocol}://{hostname}/api/v3'
variables:
hostname:
description: Self-hosted Enterprise Server hostname
default: HOSTNAME
protocol:
description: Self-hosted Enterprise Server protocol
default: http
externalDocs:
description: GitHub Enterprise Developer Docs
url: https://docs.github.com/[email protected]/rest/
paths:
/emojis:
get:
summary: GitHub Get Emojis
description: >-
The GET /emojis endpoint retrieves a collection of emoji data from the
API. This operation allows clients to fetch available emojis, which may
include their Unicode representations, names, categories, or other
relevant metadata depending on the API's implementation. It's a simple
read-only operation that doesn't require any path parameters and
typically returns an array or list of emoji objects that applications
can use to display, search, or filter emojis for user selection.
operationId: getEmojis
tags:
- Emojis
- Get
externalDocs:
description: API method documentation
url: >-
https://docs.github.com/[email protected]/rest/emojis/emojis#get-emojis
parameters: []
responses:
'200':
content:
application/json:
schema:
type: object
additionalProperties:
type: string
examples:
default:
$ref: '#/components/examples/emojis-get'
description: Response
'304':
$ref: '#/components/responses/not_modified'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: emojis
subcategory: emojis
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
x-webhooks:
branch-protection-rule-created:
post:
summary: >-
This event occurs when there is activity relating to branch protection
rules. For more information, see "[About protected
branches](https://docs.github.com/[email protected]/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)."
For information about the APIs to manage branch protection rules, see
[the GraphQL
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#branchprotectionrule)
or "[Branch
protection](https://docs.github.com/[email protected]/rest/branches/branch-protection)"
in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Administration" repository permission.
description: A branch protection rule was created.
operationId: branch-protection-rule/created
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-created'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
branch-protection-rule-deleted:
post:
summary: >-
This event occurs when there is activity relating to branch protection
rules. For more information, see "[About protected
branches](https://docs.github.com/[email protected]/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)."
For information about the APIs to manage branch protection rules, see
[the GraphQL
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#branchprotectionrule)
or "[Branch
protection](https://docs.github.com/[email protected]/rest/branches/branch-protection)"
in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Administration" repository permission.
description: A branch protection rule was deleted.
operationId: branch-protection-rule/deleted
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-deleted'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
branch-protection-rule-edited:
post:
summary: >-
This event occurs when there is activity relating to branch protection
rules. For more information, see "[About protected
branches](https://docs.github.com/[email protected]/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)."
For information about the APIs to manage branch protection rules, see
[the GraphQL
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#branchprotectionrule)
or "[Branch
protection](https://docs.github.com/[email protected]/rest/branches/branch-protection)"
in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Administration" repository permission.
description: A branch protection rule was edited.
operationId: branch-protection-rule/edited
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-edited'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
cache-sync:
post:
summary: >-
This event occurs when a Git ref has been successfully synced to a cache
replica. For more information, see "[About repository
caching](https://docs.github.com/[email protected]/admin/enterprise-management/caching-repositories/about-repository-caching)."
operationId: cache-sync
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#cache_sync
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-cache-sync'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: cache_sync
supported-webhook-types:
- repository
- organization
- app
check-run-completed:
post:
summary: >-
This event occurs when there is activity relating to a check run. For
information about check runs, see "[Getting started with the Checks
API](https://docs.github.com/[email protected]/rest/guides/getting-started-with-the-checks-api)."
For information about the APIs to manage check runs, see [the GraphQL
API
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#checkrun)
or "[Check
Runs](https://docs.github.com/[email protected]/rest/checks/runs)"
in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Checks" repository permission. To receive the
`rerequested` and `requested_action` event types, the app must have at
least write-level access for the "Checks" permission. GitHub Apps with
write-level access for the "Checks" permission are automatically
subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the
`created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the
check run was created. Pushes to a branch in a forked repository are not
detected and return an empty `pull_requests` array and a `null` value
for `head_branch`.
description: A check run was completed, and a conclusion is available.
operationId: check-run/completed
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-completed'
examples:
default:
$ref: '#/components/examples/check-run-completed'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-completed-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-completed-form-encoded'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-created:
post:
summary: >-
This event occurs when there is activity relating to a check run. For
information about check runs, see "[Getting started with the Checks
API](https://docs.github.com/[email protected]/rest/guides/getting-started-with-the-checks-api)."
For information about the APIs to manage check runs, see [the GraphQL
API
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#checkrun)
or "[Check
Runs](https://docs.github.com/[email protected]/rest/checks/runs)"
in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Checks" repository permission. To receive the
`rerequested` and `requested_action` event types, the app must have at
least write-level access for the "Checks" permission. GitHub Apps with
write-level access for the "Checks" permission are automatically
subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the
`created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the
check run was created. Pushes to a branch in a forked repository are not
detected and return an empty `pull_requests` array and a `null` value
for `head_branch`.
description: A new check run was created.
operationId: check-run/created
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-created'
examples:
default:
$ref: '#/components/examples/check-run-created'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-created-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-created-form-encoded'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-requested-action:
post:
summary: >-
This event occurs when there is activity relating to a check run. For
information about check runs, see "[Getting started with the Checks
API](https://docs.github.com/[email protected]/rest/guides/getting-started-with-the-checks-api)."
For information about the APIs to manage check runs, see [the GraphQL
API
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#checkrun)
or "[Check
Runs](https://docs.github.com/[email protected]/rest/checks/runs)"
in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Checks" repository permission. To receive the
`rerequested` and `requested_action` event types, the app must have at
least write-level access for the "Checks" permission. GitHub Apps with
write-level access for the "Checks" permission are automatically
subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the
`created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the
check run was created. Pushes to a branch in a forked repository are not
detected and return an empty `pull_requests` array and a `null` value
for `head_branch`.
description: >-
A check run completed, and someone requested a followup action that your
app provides. Only the GitHub App someone requests to perform an action
will receive the `requested_action` payload. For more information, see
"[Creating CI tests with the Checks
API](https://docs.github.com/[email protected]/developers/apps/guides/creating-ci-tests-with-the-checks-api)."
operationId: check-run/requested-action
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-requested-action'
examples:
default:
$ref: '#/components/examples/check-run-requested-action'
application/x-www-form-urlencoded:
schema:
$ref: >-
#/components/schemas/webhook-check-run-requested-action-form-encoded
examples:
default:
$ref: '#/components/examples/check-run-requested-action-form-encoded'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-rerequested:
post:
summary: >-
This event occurs when there is activity relating to a check run. For
information about check runs, see "[Getting started with the Checks
API](https://docs.github.com/[email protected]/rest/guides/getting-started-with-the-checks-api)."
For information about the APIs to manage check runs, see [the GraphQL
API
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#checkrun)
or "[Check
Runs](https://docs.github.com/[email protected]/rest/checks/runs)"
in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Checks" repository permission. To receive the
`rerequested` and `requested_action` event types, the app must have at
least write-level access for the "Checks" permission. GitHub Apps with
write-level access for the "Checks" permission are automatically
subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the
`created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the
check run was created. Pushes to a branch in a forked repository are not
detected and return an empty `pull_requests` array and a `null` value
for `head_branch`.
description: >-
Someone requested to re-run a check run. Only the GitHub App that
someone requests to re-run the check will receive the `rerequested`
payload.
operationId: check-run/rerequested
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-rerequested'
examples:
default:
$ref: '#/components/examples/check-run-rerequested'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-rerequested-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-rerequested-form-encoded'
responses:
'200':
description: >-
Return a 200 status to indicate that the data was received
successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-suite-completed:
post:
summary: >-
This event occurs when there is activity relating to a check suite. For
information about check suites, see "[Getting started with the Checks
API](https://docs.github.com/[email protected]/rest/guides/getting-started-with-the-checks-api)."
For information about the APIs to manage check suites, see [the GraphQL
API
documentation](https://docs.github.com/[email protected]/graphql/reference/objects#checksuite)
or "[Check
Suites](https://docs.github.com/[email protected]/rest/checks/suites)"
in the REST API documentation.
For activity relating to check runs, use the `check_run` event.
To subscribe to this event, a GitHub App must have at least read-level
access for the "Checks" permission. To receive the `requested` and
`rerequested` event types, the app must have at least write-level access
for the "Checks" permission. GitHub Apps with write-level access for the
"Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the
`completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the
check suite was created. Pushes to a branch in a forked repository are
not detected and return an empty `pull_requests` array and a `null`
value for `head_branch`.
description: >-
All check runs in a check suite have completed, and a conclusion is
available.
operationId: check-suite/completed
externalDocs:
url: >-
https://docs.github.com/[email protected]/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/jso
# --- truncated at 32 KB (4778 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-emojis-openapi.yml