group_work_items

Gets or lists a group_work_items resource.

Overview

Name	group_work_items
Type	Resource
Id	gitlab.work_items.group_work_items

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the work item.
name	string	Name or title of the object.
closed_at	string	Timestamp of when the work item was closed.
confidential	boolean	Indicates the work item is confidential.
create_note_email	string	User specific email address for the work item.
created_at	string	Timestamp of when the work item was created.
description	string	Description of the work item.
duplicated_to_work_item_url	string	URL of the work item that the work item is marked as a duplicate of.
hidden	boolean	Indicates the work item is hidden because the author has been banned.
iid	string	Internal ID of the work item.
imported	boolean	Indicates whether the work item was imported.
lock_version	integer	Lock version of the work item. Incremented each time the work item is updated.
moved_to_work_item_url	string	URL of the work item that the work item was moved to.
promoted_to_epic_url	string	URL of the epic that the work item has been promoted to.
reference	string	Internal reference of the work item. Returned in shortened format by default.
state	string	State of the work item. (OPEN, CLOSED)
title	string	Title of the work item.
updated_at	string	Timestamp of when the work item was last updated.
user_discussions_count	integer	Number of user discussions in the work item.
web_path	string	Web path of the object.
web_url	string	URL of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	assignee_wildcard_id, author_username, closed_after, closed_before, confidential, created_after, created_before, crm_contact_id, crm_organization_id, due_after, due_before, health_status_filter, iid, include_ancestors, include_descendants, iteration_wildcard_id, milestone_wildcard_id, my_reaction_emoji, release_tag_wildcard_id, search, sort, state, subscribed, updated_after, updated_before, weight, weight_wildcard_id	Work items that belong to the namespace. Generated from the GitLab GraphQL schema field Group.workItems (connection of WorkItem 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)
assignee_wildcard_id	string	Filter by assignee wildcard. Incompatible with assigneeUsernames.
author_username	string	Filter work items by author username.
closed_after	string	Work items closed after the date.
closed_before	string	Work items closed before the date.
confidential	boolean	Filter for confidential work items. If false, excludes confidential work items. If true, returns only confidential work items.
created_after	string	Work items created after the timestamp.
created_before	string	Work items created before the timestamp.
crm_contact_id	string	Filter by ID of CRM contact.
crm_organization_id	string	Filter by ID of CRM contact organization.
due_after	string	Work items due after the timestamp.
due_before	string	Work items due before the timestamp.
health_status_filter	string	Health status of the work item, "none" and "any" values are supported.
iid	string	IID of the work item. For example, "1".
include_ancestors	boolean	Include work items from ancestor groups. Ignored for project namespaces.
include_descendants	boolean	Include work items from descendant groups and projects. Ignored for project namespaces.
iteration_wildcard_id	string	Filter by iteration ID wildcard.
milestone_wildcard_id	string	Filter by milestone ID wildcard. Incompatible with milestoneTitle.
my_reaction_emoji	string	Filter by reaction emoji applied by the current user. Wildcard values NONE and ANY are supported.
release_tag_wildcard_id	string	Filter by release tag wildcard.
search	string	Search query for title or description.
sort	string	Sort work items by criteria.
state	string	Current state of the work item.
subscribed	string	Work items the current user is subscribed to.
updated_after	string	Work items updated after the timestamp.
updated_before	string	Work items updated before the timestamp.
weight	string	Weight applied to the work item, "none" and "any" values are supported.
weight_wildcard_id	string	Filter by weight ID wildcard. Incompatible with weight.

SELECT examples

list

Work items that belong to the namespace. Generated from the GitLab GraphQL schema field Group.workItems (connection of WorkItem nodes).

SELECT
id,
name,
closed_at,
confidential,
create_note_email,
created_at,
description,
duplicated_to_work_item_url,
hidden,
iid,
imported,
lock_version,
moved_to_work_item_url,
promoted_to_epic_url,
reference,
state,
title,
updated_at,
user_discussions_count,
web_path,
web_url
FROM gitlab.work_items.group_work_items
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND assignee_wildcard_id = '{{ assignee_wildcard_id }}'
AND author_username = '{{ author_username }}'
AND closed_after = '{{ closed_after }}'
AND closed_before = '{{ closed_before }}'
AND confidential = '{{ confidential }}'
AND created_after = '{{ created_after }}'
AND created_before = '{{ created_before }}'
AND crm_contact_id = '{{ crm_contact_id }}'
AND crm_organization_id = '{{ crm_organization_id }}'
AND due_after = '{{ due_after }}'
AND due_before = '{{ due_before }}'
AND health_status_filter = '{{ health_status_filter }}'
AND iid = '{{ iid }}'
AND include_ancestors = '{{ include_ancestors }}'
AND include_descendants = '{{ include_descendants }}'
AND iteration_wildcard_id = '{{ iteration_wildcard_id }}'
AND milestone_wildcard_id = '{{ milestone_wildcard_id }}'
AND my_reaction_emoji = '{{ my_reaction_emoji }}'
AND release_tag_wildcard_id = '{{ release_tag_wildcard_id }}'
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
AND subscribed = '{{ subscribed }}'
AND updated_after = '{{ updated_after }}'
AND updated_before = '{{ updated_before }}'
AND weight = '{{ weight }}'
AND weight_wildcard_id = '{{ weight_wildcard_id }}'
;