Method: customEmojis.get

  • This feature lets you retrieve details about a specific custom emoji using the emoji name or ID.

  • You can access this feature during the Google Workspace Developer Preview Program and it requires user authentication.

  • The request is made via a GET method to a specific URL with the emoji name or ID.

  • The response will contain information on the custom emoji in the CustomEmoji format.

  • You'll need specific authorization scopes related to custom emojis to use this functionality.

Returns details about a custom emoji.

Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see Learn about custom emojis in Google Chat and Manage custom emoji permissions.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

HTTP request

GET https://chat.googleapis.com/v1/{name=customEmojis/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the custom emoji.

Format: customEmojis/{customEmoji}

You can use the emoji name as an alias for {customEmoji}. For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of CustomEmoji.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

For more information, see the Authorization guide.