group_labels

Gets or lists a group_labels resource.

Overview

Name	group_labels
Type	Resource
Id	gitlab.groups.group_labels

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the label.
archived	boolean	Indicates the label is archived.
color	string	Background color of the label.
created_at	string	When the label was created.
description	string	Description of the label (Markdown rendered as HTML for caching).
lock_on_merge	boolean	Indicates this label is locked for merge requests that have been merged.
text_color	string	Text color of the label.
title	string	Content of the label.
updated_at	string	When the label was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	archived, include_ancestor_groups, include_descendant_groups, only_group_labels, search_term, title	Labels available on this group. Generated from the GitLab GraphQL schema field Group.labels (connection of Label 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.

Name	Datatype	Description
full_path	string	Full path of the group, for example gitlab-org
host	string	GitLab 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)
archived	boolean	Filters archived labels. Defaults to false.
include_ancestor_groups	boolean	Include labels from ancestor groups.
include_descendant_groups	boolean	Include labels from descendant groups.
only_group_labels	boolean	Include only group level labels.
search_term	string	Search term to find labels with.
title	string	Exact match on title. Cannot be used with searchTerm. searchIn will be ignored if title argument is provided.

SELECT examples

list

Labels available on this group. Generated from the GitLab GraphQL schema field Group.labels (connection of Label nodes).

SELECT
id,
archived,
color,
created_at,
description,
lock_on_merge,
text_color,
title,
updated_at
FROM gitlab.groups.group_labels
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND archived = '{{ archived }}'
AND include_ancestor_groups = '{{ include_ancestor_groups }}'
AND include_descendant_groups = '{{ include_descendant_groups }}'
AND only_group_labels = '{{ only_group_labels }}'
AND search_term = '{{ search_term }}'
AND title = '{{ title }}'
;