Skip to main content

group_custom_emoji

Gets or lists a group_custom_emoji resource.

Overview​

Namegroup_custom_emoji
TypeResource
Idgitlab.groups.group_custom_emoji

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringID of the emoji.
namestringName of the emoji.
created_atstringTimestamp of when the custom emoji was created.
externalbooleanWhether the emoji is an external link.
urlstringLink to file of the emoji.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectfull_path, hostinclude_ancestor_groupsCustom emoji in this namespace. Generated from the GitLab GraphQL schema field Group.customEmoji (connection of CustomEmoji nodes).

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
full_pathstringFull path of the group, for example gitlab-org
hoststringGitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
include_ancestor_groupsbooleanIncludes custom emoji from parent groups.

SELECT examples​

Custom emoji in this namespace. Generated from the GitLab GraphQL schema field Group.customEmoji (connection of CustomEmoji nodes).

SELECT
id,
name,
created_at,
external,
url
FROM gitlab.groups.group_custom_emoji
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND include_ancestor_groups = '{{ include_ancestor_groups }}'
;