GraphQL API Queries

Queries are the top-level entry points for reading data from the GitLab GraphQL API. You can explore queries interactively using the GraphiQL explorer.

Deprecated items are planned to be removed in a future release. For more information, see the GitLab deprecation process.

abuseReport

  • Status: Experiment

Find an abuse report.

Returns: AbuseReport

abuseReport arguments

Name Type Description
id AbuseReportID! ID of the abuse report.

accessTokenPermissions

  • Status: Experiment

List of permissions for fine-grained access tokens.

Returns: [AccessTokenPermission!]!

addOnPurchases

Retrieve all active add-on purchases. This query can be used in GitLab.com and self-managed environments.

Returns: [AddOnPurchase!]

addOnPurchases arguments

Name Type Description
namespaceId NamespaceID ID of namespace that the add-ons were purchased for.

adminDuoAvailabilityNamespaces

  • Status: Experiment

List groups with their resolved GitLab Duo availability for admin overrides. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AdminDuoAvailabilityNamespaceConnection

adminDuoAvailabilityNamespaces arguments

Name Type Description Default
adminLocked Boolean Filter to groups that are (or are not) the introducer of an admin lock.
duoAvailability [DuoAvailability!] Filter to groups whose effective availability is one of these values.
includeDescendants Boolean Include all descendants, not just direct children, of the parent group. false
parentId GroupID Restrict the list to descendants of the given group.
search String Filter groups by name or full path.

adminGroups

  • Status: Experiment

Find groups visible to the current admin. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: GroupInterfaceConnection

adminGroups arguments

Name Type Description Default
active Boolean When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion. null
aimedForDeletion Boolean Filter groups that are marked for deletion.
allAvailable Boolean When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence. true
ids [ID!] Filter groups by IDs.
includeSubgroups Boolean Include descendant groups of the group given in parentPath. Ignored unless parentPath is also provided. false
markedForDeletionOn Date Date when the group was marked for deletion.
not BaseGroupsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnly Boolean Only include groups where the current user has an owner role. false
parentPath ID Full path of the parent group.
search String Search query for group name or group full path.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Use similarity to rank results by closeness to search. similarity applies only when search is given and results are already scoped to the current user’s memberships, such as with ownedOnly: true or allAvailable: false. Filtering by visibilityLevel to public or internal groups only disables similarity, because the results are then no longer scoped by membership. Results fall back to id_desc when similarity does not apply. "name_asc"
topLevelOnly Boolean Only include top-level groups. false
visibilityLevel VisibilityLevelsEnum Filter groups by visibility level.

adminMemberRole

  • Status: Experiment

Finds a single admin custom role for the instance. Available only for GitLab Self-Managed.

Returns: AdminMemberRole

adminMemberRole arguments

Name Type Description
assignable Boolean Filter for member roles the current user can assign.
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

adminMemberRolePermissions

  • Status: Experiment

List of all admin customizable permissions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CustomizableAdminPermissionConnection

adminMemberRoles

  • Status: Experiment

Admin custom roles available for the instance. Available only for GitLab Self-Managed. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AdminMemberRoleConnection

adminMemberRoles arguments

Name Type Description
assignable Boolean Filter for member roles the current user can assign.
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

adminProjects

  • Status: Experiment

Find projects visible to the current admin. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectInterfaceConnection

adminProjects arguments

Name Type Description Default
active Boolean Filters by projects that are not archived and not marked for deletion.
aimedForDeletion Boolean Return only projects marked for deletion.
archived ProjectArchived Filter projects by archived status.
duoLicensedFeature DuoLicensedFeature Introduced as an experiment in GitLab 18.11.

Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths [String!] Filter projects by full paths. You cannot provide more than 50 full paths.
ids [ID!] Filter projects by IDs.
includeHidden Boolean Include hidden projects.
lastRepositoryCheckFailed Boolean Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn Date Date when the project was marked for deletion.
membership Boolean Return only projects that the current user is a member of.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
namespacePath ID Filter projects by their namespace’s full path (group or user).
notAimedForDeletion Boolean Exclude projects that are marked for deletion.
personal Boolean Return only personal projects.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: css or ruby.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Defaults to id_desc, or similarity if search used. null
topics [String!] Filter projects by topics.
trending Boolean Deprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevel VisibilityLevelsEnum Filter projects by visibility level.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.

aiCatalogAgentFlowConfig

  • Status: Experiment

Get flow configuration for an AI Catalog agent.

Returns: String

aiCatalogAgentFlowConfig arguments

Name Type Description
agentVersionId AiCatalogItemVersionID! Global ID of the agent version to use.
flowConfigType AiCatalogFlowConfigType! Type of flow configuration to generate.

aiCatalogBuiltInTools

  • Status: Experiment

List of AI Catalog built-in tools. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogBuiltInToolConnection

aiCatalogConfiguredItems

  • Status: Experiment

AI Catalog items configured for use. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogItemConsumerConnection!

aiCatalogConfiguredItems arguments

Name Type Description Default
configurableForProjectId ProjectID Project ID to filter AI Catalog item consumers. When provided with group_id, returns only consumers whose associated items are configurable within the project (i.e., group-enabled items that are public or owned by the project). Excludes consumers for items that are private to other projects.
foundationalFlowReference String Filter by foundational flow reference.
groupId GroupID Group ID to retrieve configured AI Catalog items for.
includeFoundationalConsumers Boolean Introduced as an experiment in GitLab 18.10.

Include configured foundational AI Catalog items.
false
includeInherited Boolean Include configured AI Catalog items inherited from the project’s top-level group. Can only be used with projectId.
itemId AiCatalogItemID Item ID to retrieve configured AI Catalog items for.
itemType AiCatalogItemType Type of items to retrieve.
itemTypes [AiCatalogItemType!] Types of items to retrieve.
projectId ProjectID Project ID to retrieve configured AI Catalog items for.
sort AiCatalogConfiguredItemsSort Sort configured items, for example by usage.

aiCatalogCustomAndFoundationalItems

  • Status: Experiment

List of AI Catalog items, including foundational items. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogCustomAndFoundationalItemConnection!

aiCatalogCustomAndFoundationalItems arguments

Name Type Description Default
itemTypes [AiCatalogItemType!] Types of items to retrieve.
search String Search items by name and description.
sort AiCatalogItemsSort Sort order of items. CATALOG_PRIORITY

aiCatalogItem

  • Status: Experiment

Find an AI Catalog item.

Returns: AiCatalogItem

aiCatalogItem arguments

Name Type Description Default
id AiCatalogItemID! Global ID of the catalog item to find.
showSoftDeleted Boolean Whether to show the item if it has been soft-deleted. Defaults to false. false

aiCatalogItemConsumer

  • Status: Experiment

Find a single AI Catalog item consumer by ID.

Returns: AiCatalogItemConsumer

aiCatalogItemConsumer arguments

Name Type Description
id AiCatalogItemConsumerID! Global ID of the AI Catalog item consumer.

aiCatalogItemVersions

  • Status: Experiment

Public AI Catalog item versions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogItemVersionConnection!

aiCatalogItemVersions arguments

Name Type Description Default
createdAfter Time Item versions created after the timestamp.
excludeDeprecated Boolean Whether to exclude deprecated versions from the results. Defaults to true. true

aiCatalogItems

  • Status: Experiment

List of AI Catalog items. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogItemConnection!

aiCatalogItems arguments

Name Type Description Default
itemType AiCatalogItemType Type of items to retrieve.
itemTypes [AiCatalogItemType!] Types of items to retrieve.
search String Search items by name and description.
sort AiCatalogItemsSort Sort order of items. CATALOG_PRIORITY

aiCatalogMcpServer

  • Status: Experiment

Find an AI Catalog MCP server by ID.

Returns: AiCatalogMcpServer

aiCatalogMcpServer arguments

Name Type Description
id AiCatalogMcpServerID! Global ID of the MCP server.

aiCatalogMcpServers

  • Status: Experiment

List of AI Catalog MCP servers. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogMcpServerConnection!

aiCatalogMcpTools

  • Status: Experiment

List of MCP tools dynamically discovered from the GitLab MCP server. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiCatalogMcpToolConnection!

aiChatAvailableModels

  • Status: Experiment

Get available models for Duo Agentic Chat. This field can be resolved only once in any single request.

Returns: AvailableModels

aiChatAvailableModels arguments

Name Type Description
namespaceId GroupID Global ID of the namespace the user is acting on.
projectId ProjectID Global ID of the project the user is acting on.
rootNamespaceId GroupID Global ID of the top-level namespace the user is acting on.

aiChatContextPresets

Get available GitLab Duo Chat context presets for the current user for a specific URL.

Returns: ContextPreset

aiChatContextPresets arguments

Name Type Description
foundationalAgentReference String Reference of the selected foundational chat agent.
namespaceId NamespaceID Global ID of the namespace the user is acting on.
projectId ProjectID Global ID of the project the user is acting on.
questionCount Int Number of questions for the default screen.
resourceId AiModelID Global ID of the resource from the current page.
url String URL of the page the user is currently on.

aiChatIncludedProjects

  • Status: Experiment

Get projects that can be included by the current user in a GitLab Duo Chat context. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectConnection

aiChatIncludedProjects arguments

Name Type Description
search String Search query, which can be for the project name or path. Minimum 3 characters.

aiConversationThreads

  • Status: Experiment

List conversation threads of AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiConversationsThreadConnection!

aiConversationThreads arguments

Name Type Description
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
id AiConversationThreadID Id of the thread.

aiDomainSettings

  • Status: Experiment

List of allowed or denied domains for AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: StringConnection

aiDomainSettings arguments

Name Type Description
domainSettingType AiDomainSettingType! Type of domain setting to retrieve.
search String Filter domains by substring match.

aiFeatureSettings

  • Status: Experiment

List of configurable AI features. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiFeatureSettingConnection

aiFeatureSettings arguments

Name Type Description
selfHostedModelId AiSelfHostedModelID Global ID of the self-hosted model.

aiFlowsMetadata

  • Status: Experiment

Metadata describing Duo Agent Platform flow capabilities available to the caller.

Returns: AiFlowsMetadata

aiFlowsMetadata arguments

Name Type Description
clientType AiFlowsMetadataClientType Client surface making the request. Used to gate per-surface capabilities. When omitted, defaults to CLI behavior for backwards compatibility.
namespaceId NamespaceID Global ID of the group or personal namespace to compute flow capabilities for. When omitted, only namespace-independent capabilities are returned.
projectId ProjectID Global ID of the project to compute flow capabilities for. Takes precedence over namespaceId when both are given.

aiFoundationalChatAgent

  • Status: Experiment

Core agent in GitLab.

Returns: AiFoundationalChatAgent

aiFoundationalChatAgent arguments

Name Type Description
reference String! Reference to the foundational chat agent.

aiFoundationalChatAgents

  • Status: Experiment

Core agents in GitLab. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiFoundationalChatAgentConnection!

aiFoundationalChatAgents arguments

Name Type Description
namespaceId NamespaceID Global ID of the namespace where the chat is present.
projectId ProjectID Global ID of the project where the chat is present.

aiMessages

  • Status: Experiment

Find GitLab Duo Chat messages. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiMessageConnection!

aiMessages arguments

Name Type Description
conversationType AiConversationsThreadsConversationType Conversation type of the thread.
requestIds [ID!] Array of request IDs to fetch.
roles [AiMessageRole!] Array of roles to fetch.
threadId AiConversationThreadID Global Id of the existing thread.If it is not specified, the last thread for the specified conversation_type will be retrieved.

aiModelSelectionNamespaceSettings

  • Status: Experiment

List of configurable AI features for namespace Model Selection. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiModelSelectionNamespaceFeatureSettingConnection

aiModelSelectionNamespaceSettings arguments

Name Type Description
groupId GroupID! Group for the model selection.

aiSelfHostedModels

  • Status: Experiment

Returns the self-hosted model if an ID is provided, otherwise returns all models. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiSelfHostedModelConnection

aiSelfHostedModels arguments

Name Type Description
id AiSelfHostedModelID Global ID of a self-hosted model.

aiSlashCommands

Get available GitLab Duo Chat slash commands for the current user for a specific URL.

Returns: [SlashCommand!]

aiSlashCommands arguments

Name Type Description
url String! URL of the page the user is currently on.

aiToolRules

  • Status: Experiment

AI tool governance rules for a namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AiToolRuleConnection

aiToolRules arguments

Name Type Description
actionType AiToolActionType Filter tools by action type.
fullPath ID! Full path of the root namespace to fetch tool rules for.
projectPath ID Full path of the project to fetch effective tool rules for. When provided, returns the merged effective rules for the project, applying most-restrictive-wins across namespace and project rules.
search String Case-insensitive text search on tool name or display name.
source AiToolSource Introduced as an experiment in GitLab 19.7.

Filter tools by source.

aiUsageData

  • Status: Experiment

Instance level AI-related data. Admins only.

Returns: AiInstanceUsageData

artifactRegistryRoleAssignments

  • Status: Experiment

Direct Artifact Registry role assignments on the given resources. Returns only roles assigned on a resource itself, not members who inherit access from a membership on an ancestor namespace, so it is not a complete list of everyone who can access the resource. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ArtifactRegistryRoleAssignmentConnection

artifactRegistryRoleAssignments arguments

Name Type Description Default
assigneeIds [UserID!] Global IDs of users to read direct role assignments on repositories for, at most 20. Cannot be combined with resourceIds. The organization owner and admins of the Artifact Registry namespace may use it. []
resourceIds [String!] UUIDs of the Artifact Registry resources to read role assignments for. Empty reads the whole organization, which only the organization owner may do. []
roles [ArtifactRegistryRole!] Only return assignments for these roles. []

auditEventDefinitions

Definitions for all audit events available on the instance. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AuditEventDefinitionConnection!

auditEventsInstanceAmazonS3Configurations

Deprecated in GitLab 18.10. Use auditEventsInstanceStreamingDestinations with amazonS3 category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: InstanceAmazonS3ConfigurationTypeConnection

auditEventsInstanceStreamingDestinations

  • Status: Experiment

Instance-level external audit event streaming destinations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: InstanceAuditEventStreamingDestinationConnection

blobSearch

  • Status: Experiment

Find code visible to the current user.

Returns: BlobSearch

blobSearch arguments

Name Type Description Default
chunkCount Int Introduced as an experiment in GitLab 17.2.

Maximum chunks per file.
3
excludeForks Boolean Introduced as an experiment in GitLab 17.11.

Excludes forked projects in the search. Always false for project search. Default is true.
true
groupId GroupID Introduced as an experiment in GitLab 17.2.

Group to search in.
includeArchived Boolean Introduced as an experiment in GitLab 17.7.

Includes archived projects in the search. Always true for project search. Default is false.
false
language [String!] Introduced as an experiment in GitLab 19.3.

Filter results to the given detected languages (for example, ["Ruby", "Go"]).
page Int Introduced as an experiment in GitLab 17.2.

Page number to fetch the results.
1
perPage Int Introduced as an experiment in GitLab 17.2.

Number of results per page.
20
projectId ProjectID Introduced as an experiment in GitLab 17.2.

Project to search in.
regex Boolean Introduced as an experiment in GitLab 17.3.

Uses the regular expression search mode. Default is false.
false
repositoryRef String Introduced as an experiment in GitLab 17.2.

Repository reference to search in.
search String! Searched term.

boardList

Find an issue board list.

Returns: BoardList

boardList arguments

Name Type Description
id ListID! Global ID of the list.
issueFilters BoardIssueInput Filters applied when getting issue metadata in the board list.

ciApplicationSettings

CI related settings that apply to the entire instance.

Returns: CiApplicationSettings

ciCatalogBundledResources

  • Status: Experiment

GitLab-maintained bundled CI/CD Catalog resources available on the current cell. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiCatalogBundledResourceConnection

ciCatalogResource

  • Status: Experiment

A single CI/CD Catalog resource visible to an authorized user.

Returns: CiCatalogResource

ciCatalogResource arguments

Name Type Description
fullPath ID CI/CD Catalog resource full path.
id CiCatalogResourceID CI/CD Catalog resource global ID.

ciCatalogResources

  • Status: Experiment

All CI/CD Catalog resources under a common namespace, visible to an authorized user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiCatalogResourceConnection

ciCatalogResources arguments

Name Type Description Default
groupIds [GroupID!] Filter catalog resources to those whose project namespace matches one of the given groups.
minAccessLevel AccessLevelEnum Minimum access level required for the user on the catalog resource project.
scope CiCatalogResourceScope Scope of the returned catalog resources. ALL
search String Search term to filter the catalog resources by name or description.
sort CiCatalogResourceSort Sort catalog resources by given criteria.
topics [String!] Filter catalog resources by project topic names.
verificationLevel CiCatalogResourceVerificationLevel Filter catalog resources by verification level.

ciConfig

Deprecated in GitLab 18.1. Use CiLint mutation: https://docs.gitlab.com/api/graphql/reference/mutations/#cilint.

Returns: CiConfig

ciConfig arguments

Name Type Description
content String! Contents of .gitlab-ci.yml.
dryRun Boolean Run pipeline creation simulation, or only do static check.
projectPath ID! Project of the CI config.
sha String Sha for the pipeline.
skipVerifyProjectSha Boolean Introduced as an experiment in GitLab 16.5.

If the provided sha is found in the project’s repository but is not associated with a Git reference (a detached commit), the verification fails and a validation error is returned. Otherwise, verification passes, even if the sha is invalid. Set to true to skip this verification process.

ciDedicatedHostedRunnerFilters

Returns available filters for GitLab Dedicated runner usage data.

Returns: CiDedicatedHostedRunnerFilters

ciDedicatedHostedRunnerUsage

Compute usage data for runners across namespaces on GitLab Dedicated. Defaults to the current year if no year or billing month is specified. Ultimate only. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiDedicatedHostedRunnerUsageConnection

ciDedicatedHostedRunnerUsage arguments

Name Type Description
billingMonth Date First day of the month to retrieve data for.
grouping GroupingEnum Groups usage data by instance aggregate or root namespace.
runnerId CiRunnerID Runner ID to retrieve data for.
year Int Year to retrieve data for.

ciMinutesProjectMonthlyUsage

Compute usage data for projects in a namespace for a given month. Returns project usage independent of whether a namespace-level usage record exists. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiMinutesProjectMonthlyUsageConnection

ciMinutesProjectMonthlyUsage arguments

Name Type Description
date Date Date for which to retrieve the usage data, should be the first day of a month. Defaults to the current month.
namespaceId NamespaceID Global ID of the Namespace for the project compute usage.

ciMinutesUsage

Compute usage data for a namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiMinutesNamespaceMonthlyUsageConnection

ciMinutesUsage arguments

Name Type Description
date Date Date for which to retrieve the usage data, should be the first day of a month.
namespaceId NamespaceID Global ID of the Namespace for the monthly compute usage.

ciPipelineStage

Stage belonging to a CI pipeline.

Returns: CiStage

ciPipelineStage arguments

Name Type Description
id CiStageID! Global ID of the CI stage.

ciQueueingHistory

Time taken for CI jobs to be picked up by runner by percentile. Enable the ClickHouse database backend to use this query.

Returns: QueueingDelayHistory

ciQueueingHistory arguments

Name Type Description
fromTime Time Start of the requested time. Defaults to three hours ago.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toTime Time End of the requested time. Defaults to the current time.

ciVariables

List of the instance’s CI/CD variables. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiInstanceVariableConnection

ciVariables arguments

Name Type Description
sort CiVariableSort Sort order of results.

cloudConnectorStatus

  • Status: Experiment

Run a series of status checks for Cloud Connector features.

Returns: CloudConnectorStatus

complianceFrameworkTemplates

List of available compliance framework templates.

Returns: [ComplianceFrameworkTemplate!]

complianceFrameworkTemplates arguments

Name Type Description
id ComplianceManagementFrameworksTemplateRegistryTemplateID Filter by template ID.

complianceRequirementControls

Get the list of all the compliance requirement controls.

Returns: ComplianceRequirementControl

containerRepository

Find a container repository.

Returns: ContainerRepositoryDetails

containerRepository arguments

Name Type Description
id ContainerRepositoryID! Global ID of the container repository.

currentLicense

Fields related to the current license.

Returns: CurrentLicense

currentUser

Get information about current user.

Returns: CurrentUser

customDashboard

Find a custom dashboard by ID.

Returns: CustomDashboard

customDashboard arguments

Name Type Description
id AnalyticsCustomDashboardsDashboardID! Dashboard ID.

customDashboards

Find custom dashboards for an organization. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CustomDashboardInterfaceConnection

customDashboards arguments

Name Type Description Default
createdById UserID Filter by dashboard creator.
namespaceId NamespaceID Filter by namespace.
organizationId OrganizationsOrganizationID Organization ID to filter dashboards. Must be the current organization, which is used when not provided.
scope CustomDashboardScope Filter dashboards by scope. ALL
search String Filter dashboards by name.

customField

  • Status: Experiment

Find a custom field by its ID.

Returns: CustomField

customField arguments

Name Type Description
id IssuablesCustomFieldID! Global ID of the custom field.

customSystemDashboard

Find a GitLab-provided system dashboard by slug.

Returns: CustomSystemDashboard

customSystemDashboard arguments

Name Type Description
slug String! Slug of the system dashboard (e.g. “duo_and_sdlc_trends”).

dependency

Find a dependency.

Returns: Dependency

dependency arguments

Name Type Description
id SbomOccurrenceID! Global ID of the Dependency.

designManagement

Fields related to design management.

Returns: DesignManagement!

devopsAdoptionEnabledNamespaces

Get configured DevOps adoption namespaces. Status: Beta. This endpoint is subject to change without notice. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: DevopsAdoptionEnabledNamespaceConnection

devopsAdoptionEnabledNamespaces arguments

Name Type Description
displayNamespaceId NamespaceID Filter by display namespace.

duoDefaultNamespaceCandidates

  • Status: Experiment

List namespaces suitable to be set as default namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: NamespaceConnection

duoSettings

  • Status: Experiment

Get GitLab Duo settings.

Returns: DuoSettings

duoWorkflowBranches

  • Status: Experiment

The alternative branches to the provided user message. Multiple branches can be created when a user retries a message. Returns an error unless the message is on the current branch of the session. Returns an empty list if the session does not store incremental checkpoints.

Returns: [DuoWorkflowBranch!]

duoWorkflowBranches arguments

Name Type Description
threadTs String! Identifier of the checkpoint that introduced a user message, from DuoMessage.threadTs. Must be a message on the current branch of the session. Returns the other attempts at the same turn, so the branch that message belongs to is excluded.
workflowId AiDuoWorkflowsWorkflowID! Global ID of the session.

duoWorkflowEvents

  • Status: Experiment

List the events for a Duo Agent Platform. Returns only the latest checkpoint by default. Use first and after to page through history. Returns at most 5 checkpoints per page. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: DuoWorkflowEventConnection!

duoWorkflowEvents arguments

Name Type Description
workflowId AiDuoWorkflowsWorkflowID! Array of request IDs to fetch.

duoWorkflowRecentSessionProjects

  • Status: Experiment

Projects the current user has Duo Agent Platform sessions in, ordered by most recent session activity. Not a complete list: limited to the 50 most recent projects.

Returns: [Project!]

duoWorkflowWorkflows

List the workflows owned by the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: DuoWorkflowConnection!

duoWorkflowWorkflows arguments

Name Type Description Default
environment WorkflowEnvironment Environment, for example, IDE or web.
excludeCreatedInteractiveCliSessions Boolean Introduced as an experiment in GitLab 19.6.

Exclude CREATED sessions from the DUO_CLI_INTERACTIVE and DUO_CLI_ACP sources. Explicit ids and workflowId lookups bypass this filter.
false
excludeSourceTypes [DuoWorkflowSourceType!] Introduced as an experiment in GitLab 19.5.

Source types to exclude. Sessions with no recorded source type are never excluded.
excludeTypes [String!] Types of flows to exclude (for example, [“software_development”, “chat”]).
ids [AiDuoWorkflowsWorkflowID!] Filter flows by a list of IDs.
mergeRequestIid String IID of a merge request to filter flows by. Requires projectId or projectPath outside a project.
projectId ProjectID Global ID of the project that contains the flows.
projectPath ID Full path of the project that contains the flows.
search String Flow title or goal to search for. When the duo_workflow_project_search_guard feature flag is enabled, words shorter than 3 characters are ignored and at most 10 words are matched. If every word is shorter than 3 characters, the whole term must match the title or goal exactly. Searches also only match sessions created in the last 30 days, unless the search is only session IDs. When disabled, every word is matched against all sessions.
sort DuoWorkflowsWorkflowSort Sort flows by the criteria. created_desc
statusGroup DuoWorkflowStatusGroup Status group to filter flow sessions by.
statuses [DuoWorkflowStatus!] Exact statuses to filter flow sessions by. Cannot be combined with statusGroup.
type String Type of flow to filter by (for example, software_development or foundational_chat_agents).
updatedAfter ISO8601DateTime Filters flows updated after a given date.
workItemIid String IID of a work item to filter flows by. Requires projectId or projectPath outside a project.
workflowId AiDuoWorkflowsWorkflowID Flow ID to filter by.

echo

Testing endpoint to validate the API with.

Returns: String!

echo arguments

Name Type Description
text String! Text to echo back.

epicBoardList

Returns: EpicList

epicBoardList arguments

Name Type Description
epicFilters EpicFilters Filters applied when getting epic metadata in the epic board list.
id BoardsEpicListID! Global ID of the list.

featureFlagEnabled

Deprecated in GitLab 17.4. Replaced with metadata.featureFlags.

Returns: Boolean!

featureFlagEnabled arguments

Name Type Description
name String! Name of the feature flag.

frecentGroups

A user’s frecently visited groups.

Returns: [Group!]

frecentGroups arguments

Name Type Description Default
scopeToOrganization Boolean Limits results to groups in the current organization. false

frecentProjects

A user’s frecently visited projects.

Returns: [Project!]

functionalVerificationStatus

  • Status: Experiment

Status of a GitLab Duo Agent Platform functional verification check.

Returns: FunctionalVerificationStatus

functionalVerificationStatus arguments

Name Type Description
checkType FunctionalVerificationCheckType! Type of functional verification check to read the status of.

geoNode

Find a Geo node.

Returns: GeoNode

geoNode arguments

Name Type Description
name String Name of the Geo node. Defaults to the current Geo node name.

gitlabCreditsAvailable

  • Status: Experiment

Whether GitLab credits are available for the current user.

Returns: Boolean!

gitlabCreditsAvailable arguments

Name Type Description
namespaceId NamespaceID Global ID of the namespace to check credits for.

gitlabCreditsUnavailableReason

  • Status: Experiment

Reason GitLab credits are unavailable. Returns “usage_billing_forbidden” when usage billing is not available for the account, and “namespace_missing” when there is no namespace to bill the usage to. Returns null when credits are available or the unavailability reason is not recognized.

Returns: AiCreditsDenialReason

gitlabCreditsUnavailableReason arguments

Name Type Description
namespaceId NamespaceID Global ID of the namespace to check credits for.

gitpodEnabled

Whether Ona is enabled in application settings.

Returns: Boolean

googleCloudArtifactRegistryRepositoryArtifact

  • Status: Experiment

Details about an artifact in the Google Artifact Registry.

Returns: GoogleCloudArtifactRegistryArtifactDetails

googleCloudArtifactRegistryRepositoryArtifact arguments

Name Type Description
googleCloudProjectId String! ID of the Google Cloud project.
image String! Name of the image in the Google Artifact Registry.
location String! Location of the Artifact Registry repository.
projectPath ID! Full project path.
repository String! Repository on the Google Artifact Registry.

group

Find a group.

Returns: Group

group arguments

Name Type Description
fullPath ID! Full path of the group. For example, gitlab-org/gitlab-foss.

groupSecret

  • Status: Experiment

View a specific group secret.

Returns: GroupSecret

groupSecret arguments

Name Type Description
groupPath ID! Group the secret belongs to.
name String! Name of the group secret to view.

groupSecrets

  • Status: Experiment

List group secrets. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: GroupSecretConnection

groupSecrets arguments

Name Type Description
groupPath ID! Group the secrets belong to.

groupSecretsCount

  • Status: Experiment

Total number of secrets in a group.

Returns: Int

groupSecretsCount arguments

Name Type Description
groupPath ID! Full path of the group.

groupSecretsManager

  • Status: Experiment

Find a group secrets manager.

Returns: GroupSecretsManager

groupSecretsManager arguments

Name Type Description
groupPath ID! Group of the secrets manager.

groupSecretsNeedingRotation

  • Status: Experiment

List group secrets that need to be rotated. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: GroupSecretConnection

groupSecretsNeedingRotation arguments

Name Type Description
groupPath ID! Group the secrets belong to.

groupSecretsPermissions

  • Status: Experiment

List group secrets permissions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: GroupSecretsPermissionConnection

groupSecretsPermissions arguments

Name Type Description
groupPath ID! Group the secrets permission belong to.

groups

Find groups. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: GroupConnection

groups arguments

Name Type Description Default
active Boolean When nil (default value), returns all groups. When true, returns only groups that are not pending deletion. When false, only returns groups that are pending deletion. null
aimedForDeletion Boolean Filter groups that are marked for deletion.
allAvailable Boolean When true, returns all accessible groups. When false, returns only groups where the user is a member. Unauthenticated requests always return all public groups. The owned_only argument takes precedence. true
ids [ID!] Filter groups by IDs.
includeSubgroups Boolean Include descendant groups of the group given in parentPath. Ignored unless parentPath is also provided. false
markedForDeletionOn Date Date when the group was marked for deletion.
not BaseGroupsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
ownedOnly Boolean Only include groups where the current user has an owner role. false
parentPath ID Full path of the parent group.
search String Search query for group name or group full path.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Use similarity to rank results by closeness to search. similarity applies only when search is given and results are already scoped to the current user’s memberships, such as with ownedOnly: true or allAvailable: false. Filtering by visibilityLevel to public or internal groups only disables similarity, because the results are then no longer scoped by membership. Results fall back to id_desc when similarity does not apply. "name_asc"
topLevelOnly Boolean Only include top-level groups. false
visibilityLevel VisibilityLevelsEnum Filter groups by visibility level.
withDuoAgentPlatformEnabled Boolean Introduced as an experiment in GitLab 19.6.

Return only groups whose top-level group has Duo Agent Platform turned on. On GitLab Self-Managed and GitLab Dedicated, returns no groups when Duo Agent Platform is turned off for the instance.
false
withKnowledgeGraphEnabled Boolean Introduced as an experiment in GitLab 18.10.

Return only groups with Knowledge Graph enabled.
false

instanceExternalAuditEventDestinations

Deprecated in GitLab 18.10. Use auditEventsInstanceStreamingDestinations instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: InstanceExternalAuditEventDestinationConnection

instanceGoogleCloudLoggingConfigurations

Deprecated in GitLab 18.10. Use auditEventsInstanceStreamingDestinations with gcpLogging category instead. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: InstanceGoogleCloudLoggingConfigurationTypeConnection

instanceSecretsManagerEnrollment

  • Status: Experiment

Check if Secrets Manager is enrolled at the instance level.

Returns: SecretsManagerInstanceEnrollment

instanceSecurityDashboard

Fields related to Instance Security Dashboard.

Returns: InstanceSecurityDashboard

integrationExclusions

  • Status: Experiment

This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: IntegrationExclusionConnection

integrationExclusions arguments

Name Type Description
integrationName IntegrationType! Type of integration.

issue

Find an issue.

Returns: Issue

issue arguments

Name Type Description
id IssueID! Global ID of the issue.

issues

  • Status: Experiment

Find issues visible to the current user. At least one filter must be provided. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: IssueConnection

issues arguments

Name Type Description Default
assigneeId String ID of a user assigned to the issues. Wildcard values “NONE” and “ANY” are supported.
assigneeUsername String Deprecated in GitLab 13.11. Use assigneeUsernames.
assigneeUsernames [String!] Usernames of users assigned to the issue.
assigneeWildcardId AssigneeWildcardId Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
authorUsername String Username of the author of the issue.
closedAfter Time Issues closed after the date.
closedBefore Time Issues closed before the date.
confidential Boolean Filter for confidential issues. If “false”, excludes confidential issues. If “true”, returns only confidential issues.
createdAfter Time Issues created after the date.
createdBefore Time Issues created before the date.
crmContactId String ID of a contact assigned to the issues.
crmOrganizationId String ID of an organization assigned to the issues.
customField [WorkItemWidgetCustomFieldFilterInputType!] Introduced as an experiment in GitLab 17.10.

Filter by custom fields.
dueAfter Time Return issues due on or after the given time.
dueBefore Time Return issues due on or before the given time.
epicId String ID of an epic associated with the issues, “none” and “any” values are supported.
epicWildcardId EpicWildcardId Filter by epic ID wildcard. Incompatible with epicId.
healthStatusFilter HealthStatusFilter Health status of the issue, “none” and “any” values are supported.
iid String IID of the issue. For example, “1”.
iids [String!] List of IIDs of issues. For example, ["1", "2"].
in [IssuableSearchableField!] Specify the fields to perform the search in. Defaults to [TITLE, DESCRIPTION]. Requires the search argument.'.
includeArchived Boolean Whether to include issues from archived projects. Defaults to false. false
includeSubepics Boolean Whether to include subepics when filtering issues by epicId.
iterationCadenceId [IterationsCadenceID!] Filter by a list of iteration cadence IDs.
iterationId [ID] List of iteration Global IDs applied to the issue.
iterationTitle String Filter by iteration title.
iterationWildcardId IterationWildcardId Filter by iteration ID wildcard.
labelName [String] Labels applied to the issue.
milestoneTitle [String] Milestone applied to the issue.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard.
myReactionEmoji String Filter by reaction emoji applied by the current user. Wildcard values “NONE” and “ANY” are supported.
not NegatedIssueFilterInput Negated arguments.
or UnionedIssueFilterInput List of arguments with inclusive OR.
search String Search query for title or description.
sort IssueSort Sort issues by the criteria. created_desc
state IssuableState Current state of the issue.
status WorkItemWidgetStatusFilterInput Introduced as an experiment in GitLab 18.0.

Filter by status.
subscribed SubscriptionStatus Issues the current user is subscribed to.
types [IssueType!] Filter issues by the given issue types.
updatedAfter Time Issues updated after the date.
updatedBefore Time Issues updated before the date.
weight String Weight applied to the issue, “none” and “any” values are supported.
weightWildcardId WeightWildcardId Filter by weight ID wildcard. Incompatible with weight.
workItemTypeIds [WorkItemsTypeID!] Filter issues by work item type global IDs.

iteration

Find an iteration.

Returns: Iteration

iteration arguments

Name Type Description
id IterationID! Find an iteration by its ID.

jobs

All jobs on this GitLab instance. Returns an empty result for users without administrator access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiJobInterfaceConnection

jobs arguments

Name Type Description
compatibleRunnerId CiRunnerID Introduced as an experiment in GitLab 18.1.

ID of a runner that matches the requirements of the jobs returned (normally used when filtering pending jobs).
failureReason CiJobFailureReason Introduced as an experiment in GitLab 16.4.

Filter jobs by failure reason. Currently only RUNNER_SYSTEM_FAILURE together with runnerTypes: INSTANCE_TYPE is supported.
runnerTypes [CiRunnerType!] Introduced as an experiment in GitLab 16.4.

Filter jobs by runner type if feature flag :admin_jobs_filter_runner_type is enabled.
statuses [CiJobStatus!] Filter jobs by status.
  • Status: Experiment

LDAP admin links. Available only for GitLab Self-Managed. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: LdapAdminRoleLinkConnection

licenseHistoryEntries

Fields related to entries in the license history. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: LicenseHistoryEntryConnection

memberRole

  • Status: Experiment

Finds a single custom role for the instance. Available only for GitLab Self-Managed.

Returns: MemberRole

memberRole arguments

Name Type Description
assignable Boolean Filter for member roles the current user can assign.
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

memberRolePermissions

  • Status: Experiment

List of all standard customizable permissions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CustomizableStandardPermissionConnection

memberRoles

  • Status: Experiment

Custom roles available for the instance. Available only for GitLab Self-Managed. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: MemberRoleConnection

memberRoles arguments

Name Type Description
assignable Boolean Filter for member roles the current user can assign.
id MemberRoleID Global ID of the member role to look up.
ids [MemberRoleID!] Global IDs of the member role to look up.
orderBy MemberRolesOrderBy Ordering column. Default is NAME.
sort SortDirectionEnum Ordering column. Default is ASC.

mergeRequest

Find a merge request.

Returns: MergeRequest

mergeRequest arguments

Name Type Description
id MergeRequestID! Global ID of the merge request.

mergeRequests

  • Status: Experiment

Find merge requests visible to the current user. At least one filter must be provided. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: MergeRequestConnection

mergeRequests arguments

Name Type Description Default
approvedBy [String!] Usernames of the approvers.
approver [String!] Usernames of possible approvers.
assigneeUsername String Username of the assignee.
assigneeUsernames [String!] Usernames of users assigned to the merge request.
assigneeWildcardId AssigneeWildcardId Filter by assignee presence. Incompatible with assigneeUsernames and assigneeUsername.
authorUsername String Username of the author.
blobPath String Introduced as an experiment in GitLab 17.7.

Path of the blob changed in merge request. Requires state, targetBranches, and createdAfter arguments.
closedAfter Time Merge requests closed after the date.
closedBefore Time Merge requests closed before the date.
createdAfter Time Merge requests created after the timestamp.
createdBefore Time Merge requests created before the timestamp.
deployedAfter Time Merge requests deployed after the timestamp.
deployedBefore Time Merge requests deployed before the timestamp.
deploymentId String ID of the deployment.
draft Boolean Limit result to draft merge requests.
environmentName String Environment merge requests have been deployed to.
ignoredReviewerUsername String Introduced as an experiment in GitLab 18.0.

Username of the reviewer to ignore when searching by reviewer state.
iids [String!] Array of IIDs of merge requests, for example [1, 2].
includeArchived Boolean Whether to include merge requests from archived projects. Defaults to false. false
labelName [String] Labels applied to the merge request.
labels [String!] Deprecated in GitLab 17.1. Use labelName.
mergedAfter Time Merge requests merged after the date.
mergedBefore Time Merge requests merged before the date.
mergedBy String Username of the merger.
milestoneTitle String Title of the milestone. Incompatible with milestoneWildcardId.
milestoneWildcardId MilestoneWildcardId Filter issues by milestone ID wildcard. Incompatible with milestoneTitle.
myReactionEmoji String Filter by your reaction emoji.
not MergeRequestsResolverNegatedParams List of negated arguments. Warning: this argument is experimental and a subject to change in future.
or UnionedMergeRequestFilterInput List of arguments with inclusive OR.
releaseTag String Filter by release tag.
reviewState MergeRequestReviewState Reviewer state of the merge request.
reviewStates [MergeRequestReviewState!] Reviewer states of the merge request.
reviewerUsername String Username of the reviewer.
reviewerWildcardId ReviewerWildcardId Filter by reviewer presence. Incompatible with reviewerUsername.
sort MergeRequestSort Sort merge requests by the criteria. created_desc
sourceBranches [String!] Array of source branch names. All resolved merge requests will have one of these branches as their source.
state MergeRequestState Merge request state. If provided, all resolved merge requests will have the state.
subscribed SubscriptionStatus Merge requests the current user is subscribed to.
targetBranches [String!] Array of target branch names. All resolved merge requests will have one of these branches as their target.
updatedAfter Time Merge requests updated after the timestamp.
updatedBefore Time Merge requests updated before the timestamp.

metadata

Metadata about GitLab.

Returns: Metadata

milestone

Find a milestone.

Returns: Milestone

milestone arguments

Name Type Description
id MilestoneID! Find a milestone by its ID.

mlExperiment

Find a machine learning experiment.

Returns: MlExperiment

mlExperiment arguments

Name Type Description
id MlExperimentID! ID of the experiment.

mlModel

  • Status: Experiment

Find machine learning models.

Returns: MlModel

mlModel arguments

Name Type Description
id MlModelID! ID of the model.

namespace

Find a namespace.

Returns: Namespace

namespace arguments

Name Type Description
fullPath ID! Full path of the namespace. For example, gitlab-org/gitlab-foss.

namespaceSecretsManagerEnrollment

  • Status: Experiment

Check Secrets Manager enrollment for a namespace.

Returns: SecretsManagerEnrollment

namespaceSecretsManagerEnrollment arguments

Name Type Description
namespacePath ID! Full path of the namespace.

namespaceSecurityProjects

Security-filtered projects for a namespace. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectConnection

namespaceSecurityProjects arguments

Name Type Description Default
attributeFilters [AttributeFilterInput!] Filter projects by security attributes. Up to 20 items.
hasFailedOrWarning Boolean Introduced as an experiment in GitLab 19.0.

Filter projects by whether they have any failed security scans. Warnings have no effect on this filter.
hasScanners Boolean Introduced as an experiment in GitLab 19.0.

Filter projects by whether they have any configured security scans.
hasStale Boolean Introduced as an experiment in GitLab 19.0.

Filter projects by whether they have any failed security scans.
includeSubgroups Boolean Include also subgroup projects. false
namespaceId NamespaceID! Global ID of the namespace.
search String Search projects by name.
securityAnalyzerFilters [AnalyzerFilterInput!] Filter projects by analyzer type and status.
sortBy SortableAnalyzerType Introduced as an experiment in GitLab 19.2.

Sort projects by analyzer status.
triggerType ScanProfileTriggerType Introduced as an experiment in GitLab 19.5.

Filter projects by attached triage and remediation trigger type.
vulnerabilityCountFilters [VulnerabilityCountFilterInput!] Filter projects by vulnerability counts using comparison operators.

note

  • Status: Experiment

Find a note.

Returns: Note

note arguments

Name Type Description
id NoteID! Global ID of the note.

openbaoHealth

  • Status: Experiment

Check if OpenBao instance is healthy and reachable.

Returns: Boolean!

orbit

  • Status: Experiment

Orbit data of the instance and of the groups of the current user. Returns null when the user is not signed in.

Returns: Orbit

organization

  • Status: Experiment

Find an organization.

Returns: Organization

organization arguments

Name Type Description
id OrganizationsOrganizationID ID of the organization.

organizations

  • Status: Experiment

List organizations. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: OrganizationConnection

organizations arguments

Name Type Description Default
excludeDefault Boolean Introduced as an experiment in GitLab 19.1.

Excludes the Default organization from results.
false
search String Search query, which can be for the organization name or a path.
state OrganizationState Introduced as an experiment in GitLab 19.1.

Filter organizations by state.

package

Find a package. This field can only be resolved for one query in any single request. Returns null if a package has no default status.

Returns: PackageDetailsType

package arguments

Name Type Description
id PackagesPackageID! Global ID of the package.

packageMetadataAdvisories

  • Status: Experiment

Get multiple package metadata advisories. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: PackageMetadataAdvisoryConnection

packageMetadataAdvisories arguments

Name Type Description
createdAfter ISO8601DateTime Filter advisories created after the datetime.
identifiers [String!]! Array of advisory identifiers.
updatedAfter ISO8601DateTime Filter advisories updated after the datetime.

packageMetadataAdvisory

  • Status: Experiment

Get a package metadata advisory.

Returns: PackageMetadataAdvisory

packageMetadataAdvisory arguments

Name Type Description
id PackageMetadataAdvisoryID Global ID of the advisory.
identifier String Identifier of the advisory.

pipelineExecutionSchedulePolicyTestRun

  • Status: Experiment

Find a pipeline execution schedule policy test run by ID.

Returns: PolicyScheduleTestRun

pipelineExecutionSchedulePolicyTestRun arguments

Name Type Description
id SecurityScheduledPipelineExecutionPolicyTestRunID! Global ID of the policy schedule test run.

project

Find a project.

Returns: Project

project arguments

Name Type Description
fullPath ID! Full path of the project. For example, gitlab-org/gitlab-foss.

projectComplianceViolation

Find a project compliance violation.

Returns: ProjectComplianceViolation

projectComplianceViolation arguments

Name Type Description
id ComplianceManagementProjectsComplianceViolationID! Global ID of the project compliance violation.

projectSecret

  • Status: Experiment

View a specific project secret.

Returns: ProjectSecret

projectSecret arguments

Name Type Description
name String! Name of the project secret to view.
projectPath ID! Project the secrets belong to.

projectSecrets

  • Status: Experiment

List project secrets. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectSecretConnection

projectSecrets arguments

Name Type Description
projectPath ID! Project the secrets belong to.

projectSecretsCount

  • Status: Experiment

Total number of secrets in a project.

Returns: Int

projectSecretsCount arguments

Name Type Description
projectPath ID! Full path of the project.

projectSecretsManager

  • Status: Experiment

Find a project secrets manager.

Returns: ProjectSecretsManager

projectSecretsManager arguments

Name Type Description
projectPath ID! Project of the secrets manager.

projectSecretsNeedingRotation

  • Status: Experiment

List project secrets that need to be rotated. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectSecretConnection

projectSecretsNeedingRotation arguments

Name Type Description
projectPath ID! Project the secrets belong to.

projectSecretsPermissions

  • Status: Experiment

List project secrets permissions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectSecretsPermissionConnection

projectSecretsPermissions arguments

Name Type Description
projectPath ID! Project the secrets permissions belong to.

projects

Find projects visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: ProjectConnection

projects arguments

Name Type Description Default
active Boolean Filters by projects that are not archived and not marked for deletion.
aimedForDeletion Boolean Return only projects marked for deletion.
archived ProjectArchived Filter projects by archived status.
duoLicensedFeature DuoLicensedFeature Introduced as an experiment in GitLab 18.11.

Include only projects eligible for the specified GitLab Duo licensed feature. Results are automatically filtered to projects where the user has the Maintainer or Owner role.
fullPaths [String!] Filter projects by full paths. You cannot provide more than 50 full paths.
ids [ID!] Filter projects by IDs.
includeHidden Boolean Include hidden projects.
lastRepositoryCheckFailed Boolean Return only projects where the last repository check failed. Only available for administrators.
markedForDeletionOn Date Date when the project was marked for deletion.
membership Boolean Return only projects that the current user is a member of.
minAccessLevel AccessLevelEnum Return only projects where current user has at least the specified access level.
namespacePath ID Filter projects by their namespace’s full path (group or user).
notAimedForDeletion Boolean Exclude projects that are marked for deletion.
personal Boolean Return only personal projects.
programmingLanguageName String Filter projects by programming language name (case insensitive). For example: css or ruby.
search String Search query, which can be for the project name, a path, or a description.
searchNamespaces Boolean Include namespace in project search.
sort String Sort order of results. Format: <field_name>_<sort_direction>, for example: id_desc or name_asc. Defaults to id_desc, or similarity if search used. null
topics [String!] Filter projects by topics.
trending Boolean Deprecated in GitLab 18.8. No longer functional. Underlying feature was removed in 19.0.
visibilityLevel VisibilityLevelsEnum Filter projects by visibility level.
withIssuesEnabled Boolean Return only projects with issues enabled.
withMergeRequestsEnabled Boolean Return only projects with merge requests enabled.

queryComplexity

Information about the complexity of the GraphQL query.

Returns: QueryComplexity

restrictedVisibilityLevels

Visibility levels that are restricted on the instance. Non-administrators cannot use restricted visibility levels for groups, projects, or snippets.

Returns: [VisibilityLevelsEnum!]

runner

Find a runner.

Returns: CiRunner

runner arguments

Name Type Description
id CiRunnerID! Runner ID.

runnerPlatforms

Deprecated in GitLab 15.9. No longer used, use gitlab-runner documentation to learn about supported platforms. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: RunnerPlatformConnection

runnerSetup

Deprecated in GitLab 15.9. No longer used, use gitlab-runner documentation to learn about runner registration commands.

Returns: RunnerSetup

runnerSetup arguments

Name Type Description
architecture String! Architecture to generate the instructions for.
groupId GroupID Deprecated in GitLab 13.11. No longer used.
platform String! Platform to generate the instructions for.
projectId ProjectID Deprecated in GitLab 13.11. No longer used.

runnerUsage

Runner usage by runner. Enable the ClickHouse database backend to use this query.

Returns: [CiRunnerUsage!]

runnerUsage arguments

Name Type Description Default
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath ID Filter jobs by the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
runnerType CiRunnerType Filter runners by the type.
runnersLimit Int Maximum number of runners to return. Other runners will be aggregated to a runner: null entry. Defaults to 5 if unspecified. Maximum of 500. 5
toDate Date End of the requested date frame. Defaults to the end of the previous calendar month.

runnerUsageByProject

Runner usage by project. Enable the ClickHouse database backend to use this query.

Returns: [CiRunnerUsageByProject!]

runnerUsageByProject arguments

Name Type Description
fromDate Date Start of the requested date frame. Defaults to the start of the previous calendar month.
fullPath ID Filter jobs based on the full path of the group or project they belong to. For example, gitlab-org or gitlab-org/gitlab. Available only to administrators and users with the Maintainer role for the group (when a group is specified), or project (when a project is specified). Limited to runners from 5000 child projects.
projectsLimit Int Maximum number of projects to return. Other projects will be aggregated to a project: null entry. Defaults to 5 if unspecified. Maximum of 500.
runnerType CiRunnerType Filter jobs by the type of runner that executed them.
toDate Date End of the requested date frame. Defaults to the end of the previous calendar month.

runners

Get all runners in the GitLab instance (project and shared). Access is restricted to users with administrator access. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: CiRunnerConnection

runners arguments

Name Type Description
active Boolean Deprecated in GitLab 14.8. Renamed. Use paused instead.
creatorId UserID Filter runners by creator ID.
creatorUsername String Filter runners by creator username.
ownerFullPath String Introduced as an experiment in GitLab 17.8.

Filter runners by owning project or group.
paused Boolean Filter runners by paused (true) or active (false) status.
search String Filter by full token or partial text in description field.
sort CiRunnerSort Sort order of results.
status CiRunnerStatus Filter runners by status.
tagList [String!] Filter by tags associated with the runner (comma-separated or array).
type CiRunnerType Filter runners by type.
upgradeStatus CiRunnerUpgradeStatus Filter by upgrade status.
versionPrefix String Filter runners by version. Runners that contain runner managers with the version at the start of the search term are returned. For example, the search term ‘14.’ returns runner managers with versions ‘14.11.1’ and ‘14.2.3’.

secretPermissions

  • Status: Experiment

List secret permissions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: SecretPermissionConnection

secretPermissions arguments

Name Type Description
projectPath ID! Project the secret permission belong to.

secretsManagerInstanceEntitlement

  • Status: Experiment

Instance-wide Secrets Manager entitlement on GitLab Self-Managed. Not available on GitLab.com, where entitlement is per top-level group.

Returns: SecretsManagerEntitlement

securityConfiguration

Security configuration for the project.

Returns: SecurityConfiguration

securityConfiguration arguments

Name Type Description
projectId ProjectID! Project to get the security configuration for.

securityScanProfile

  • Status: Experiment

Get security scan profile by ID.

Returns: ScanProfileType!

securityScanProfile arguments

Name Type Description
id SecurityScanProfileID! Global ID of the security scan profile.

securityScanProfileVariables

  • Status: Experiment

Configuration variables a security scan profile of the given type can set.

Returns: [SecurityScanProfileVariable!]

securityScanProfileVariables arguments

Name Type Description
scanType SecurityScanProfileType! Scan profile type to return the configuration variables for.

selfManagedAddOnEligibleUsers

  • Status: Experiment

Users within the self-managed instance who are eligible for add-ons. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: AddOnUserConnection

selfManagedAddOnEligibleUsers arguments

Name Type Description
addOnPurchaseIds [GitlabSubscriptionsAddOnPurchaseID!]! Global IDs of the add on purchases to find assignments for.
addOnType GitlabSubscriptionsAddOnType! Type of add on to filter the eligible users by.
filterByAssignedSeat String Filter users list by assigned seat.
search String Search the user list.
sort GitlabSubscriptionsUserSort Sort the user list.

selfManagedUsersQueuedForRolePromotion

Fields related to users within a self-managed instance that are pending role promotion approval. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: UsersQueuedForRolePromotionConnection

snippets

Find Snippets visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: SnippetConnection

snippets arguments

Name Type Description
authorId UserID ID of an author.
explore Boolean Explore personal snippets.
ids [SnippetID!] Array of global snippet IDs. For example, gid://gitlab/ProjectSnippet/1.
projectId ProjectID ID of a project.
type TypeEnum Type of snippet.
visibility VisibilityScopesEnum Visibility of the snippet.

spdxLicenses

  • Status: Experiment

List of SPDX licenses from the SPDX licence catalogue.

Returns: [SpdxLicense!]

standardRole

  • Status: Experiment

Finds a single default role for the instance. Available only for GitLab Self-Managed.

Returns: StandardRole

standardRole arguments

Name Type Description
accessLevel [MemberAccessLevel!] Access level or levels to filter by.

standardRoles

  • Status: Experiment

Default roles available for the instance. Available only for GitLab Self-Managed. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: StandardRoleConnection

standardRoles arguments

Name Type Description
accessLevel [MemberAccessLevel!] Access level or levels to filter by.

subscriptionFutureEntries

Fields related to entries in future subscriptions. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: SubscriptionFutureEntryConnection

subscriptionUsage

  • Status: Experiment

Usage data of consumables under the subscription.

Returns: GitlabSubscriptionUsage

subscriptionUsage arguments

Name Type Description
endDate ISO8601Date End date of the usage period to query. Defaults to the end of the current month.
flowTypes [String!] Filter usage data by flow type identifiers (e.g. [“chat”, “code_review”]). Only applies to event-backed fields (creditsUsed, dailyUsage, dailyAverage, totalActiveUsers, totalCreditsUsed). Wallet-backed fields (monthlyWaiver, monthlyCommitment, overage) are not affected by this filter.
namespacePath ID Path of the top-level namespace. Leave it blank if querying the instance subscription.
organizationId OrganizationsOrganizationID Introduced as an experiment in GitLab 19.6.

Global ID of the organization billed through a nominated group.
startDate ISO8601Date Start date of the usage period to query. Defaults to the beginning of the current month.

syntheticNote

  • Status: Experiment

Find a synthetic note.

Returns: Note

syntheticNote arguments

Name Type Description
noteableId NoteableID! Global ID of the resource to search synthetic note on.
sha String! Global ID of the note.

timelogs

Find timelogs visible to the current user. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: TimelogConnection

timelogs arguments

Name Type Description Default
endDate Time List timelogs within a date range where the logged date is equal to or before endDate.
endTime Time List timelogs within a time range where the logged time is equal to or before endTime.
groupId GroupID List timelogs for a group.
projectId ProjectID List timelogs for a project.
sort TimelogSort List timelogs in a particular order. SPENT_AT_ASC
startDate Time List timelogs within a date range where the logged date is equal to or after startDate.
startTime Time List timelogs within a time range where the logged time is equal to or after startTime.
username String List timelogs for a user.

todo

Retrieve a single to-do item.

Returns: Todo

todo arguments

Name Type Description
id TodoID! ID of the to-do item.

topics

Find project topics. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: TopicConnection

topics arguments

Name Type Description
organizationId OrganizationsOrganizationID Introduced as an experiment in GitLab 17.7.

Global ID of the organization.
search String Search query for topic name.

trialUsage

  • Status: Experiment

Usage data for trial subscriptions.

Returns: GitlabTrialUsage

trialUsage arguments

Name Type Description
namespacePath ID Path of the top-level namespace. Leave it blank if querying the instance subscription.
organizationId OrganizationsOrganizationID Introduced as an experiment in GitLab 19.6.

Global ID of the organization billed through a nominated group.

usageTrendsMeasurements

Get statistics on the instance. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: UsageTrendsMeasurementConnection

usageTrendsMeasurements arguments

Name Type Description
identifier MeasurementIdentifier! Type of measurement or statistics to retrieve.
recordedAfter Time Measurement recorded after the date.
recordedBefore Time Measurement recorded before the date.

user

Find a user.

Returns: UserCore

user arguments

Name Type Description
id UserID ID of the User.
username String Username of the User.

users

Find users. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: UserCoreConnection

users arguments

Name Type Description Default
active Boolean Filter by active users. When true, returns active users. When false, returns non-active users.
admins Boolean Return only admin users. false
groupId GroupID Return users member of a given group.
humans Boolean Filter by regular users. When true, returns only users that are not bot or internal users. When false, returns only users that are bot or internal users.
ids [ID!] List of user Global IDs.
search String Query to search users by name, username, or primary email.
sort Sort Sort users by the criteria. created_desc
userTypes [UserType!] Introduced as an experiment in GitLab 18.3.

Filter by user type.
usernames [String!] List of usernames.

virtualRegistriesContainerRegistry

  • Status: Experiment

Find a container virtual registry. Returns null if the container_virtual_registries feature flag is disabled.

Returns: ContainerRegistryDetails

virtualRegistriesContainerRegistry arguments

Name Type Description
id VirtualRegistriesContainerRegistryID! Global ID of the container virtual registry.

virtualRegistriesContainerUpstream

  • Status: Experiment

Finds a container upstream registry with details. Returns null if the container_virtual_registries feature flag is disabled.

Returns: ContainerUpstreamDetails

virtualRegistriesContainerUpstream arguments

Name Type Description
id VirtualRegistriesContainerUpstreamID! Global ID of the container upstream.

virtualRegistriesPackagesMavenRegistry

  • Status: Experiment

Find a Maven virtual registry. Returns null if the maven_virtual_registry feature flag is disabled.

Returns: MavenRegistryDetails

virtualRegistriesPackagesMavenRegistry arguments

Name Type Description
id VirtualRegistriesPackagesMavenRegistryID! Global ID of the Maven virtual registry.

virtualRegistriesPackagesMavenUpstream

  • Status: Experiment

Find a Maven upstream registry. Returns null if the maven_virtual_registry feature flag is disabled.

Returns: MavenUpstreamDetails

virtualRegistriesPackagesMavenUpstream arguments

Name Type Description
id VirtualRegistriesPackagesMavenUpstreamID! Global ID of the Maven upstream registry.

vulnerabilities

Vulnerabilities reported on projects on the current user’s instance security dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: VulnerabilityConnection

vulnerabilities arguments

Name Type Description Default
authentication [VulnerabilityAuthenticationFilter!] Introduced as an experiment in GitLab 19.6.

Filter vulnerabilities by whether their component requires authentication. Maximum is 1000 values. This filter is not available yet, and using this argument returns an error.
authorization [VulnerabilityAuthorizationFilter!] Introduced as an experiment in GitLab 19.6.

Filter vulnerabilities by whether their component requires elevated privileges. Maximum is 1000 values. This filter is not available yet, and using this argument returns an error.
clusterAgentId [ClustersAgentID!] Filter vulnerabilities by cluster_agent_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
clusterId [ClustersClusterID!] Filter vulnerabilities by cluster_id. Vulnerabilities with a reportType of cluster_image_scanning are only included with this filter.
dismissalReason [VulnerabilityDismissalReason!] Filter by dismissal reason. Only dismissed Vulnerabilities will be included with the filter.
dueDateAfter Date Introduced as an experiment in GitLab 19.6.

Returns only the vulnerabilities due on or after the date. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerability_due_date_filter feature flag enabled. Not supported on Instance Security Dashboard queries.
dueDateBefore Date Introduced as an experiment in GitLab 19.6.

Returns only the vulnerabilities due on or before the date. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerability_due_date_filter feature flag enabled. Not supported on Instance Security Dashboard queries.
dueDateWildcard VulnerabilityDueDateWildcardId Introduced as an experiment in GitLab 19.6.

Filter vulnerabilities by whether they have a due date. Cannot be combined with dueDateAfter or dueDateBefore. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerability_due_date_filter feature flag enabled. Not supported on Instance Security Dashboard queries.
falsePositive Boolean Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities with false positive flag. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
hasAiResolution Boolean Returns only the vulnerabilities which can likely be resolved by GitLab Duo Vulnerability Resolution.
hasIssues Boolean Returns only the vulnerabilities which have linked issues.
hasMergeRequest Boolean Returns only the vulnerabilities which have linked merge requests.
hasRemediations Boolean Returns only the vulnerabilities which have remediations.
hasResolution Boolean Returns only the vulnerabilities which have been resolved on default branch.
identifierName String Filter vulnerabilities by identifier name. Ignored when applied on instance security dashboard queries.
image [String!] Filter vulnerabilities by location image. When this filter is present, the response only matches entries for a reportType that includes container_scanning, cluster_image_scanning.
malware Boolean Filter vulnerabilities by malware status. When true, returns only malware vulnerabilities (identified by GLAM-* identifiers). When false, returns only non-malware vulnerabilities. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries. Cannot be combined with trackedRefsScope: ALL_REFS or with trackedRefIds referring to a non-default-branch ref.
owaspTopTen [VulnerabilityOwaspTop10!] Filter vulnerabilities by OWASP Top 10 2017 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 values.
owaspTopTen2021 [VulnerabilityOwasp2021Top10!] Introduced as an experiment in GitLab 18.1.

Filter vulnerabilities by OWASP Top 10 2021 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2021 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
owaspTopTen2025 [VulnerabilityOwasp2025Top10!] Introduced as an experiment in GitLab 19.0.

Filter vulnerabilities by OWASP Top 10 2025 category. Wildcard value NONE is also supported but it cannot be combined with other OWASP top 10 2025 values. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyAutoDismissed Boolean Introduced as an experiment in GitLab 18.8.

Returns only the vulnerabilities which have been auto dismissed by security policies. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
policyViolations [PolicyViolations!] Introduced as an experiment in GitLab 18.6.

Filter by security policy violations. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Not supported on Instance Security Dashboard queries.
projectId [ID!] Filter vulnerabilities by project.
reachability ReachabilityType Introduced as an experiment in GitLab 18.2.

Filter vulnerabilities by reachability.
reportType [VulnerabilityReportType!] Filter vulnerabilities by report type.
scanner [String!] Filter vulnerabilities by VulnerabilityScanner.externalId.
scannerId [VulnerabilitiesScannerID!] Filter vulnerabilities by scanner ID.
securityAttributesFilters [AttributeFilterInput!] Introduced as an experiment in GitLab 19.5.

Filter vulnerabilities by the security attributes of their projects. Up to 20 filters. To use this argument, you must have advanced search configured and advanced vulnerability management set up. Available on group queries only, when the vulnerability_report_security_attributes_filter feature flag is enabled.
securityBoundary [VulnerabilitySecurityBoundaryFilter!] Introduced as an experiment in GitLab 19.6.

Filter vulnerabilities by the security boundary of their component. Maximum is 1000 values. This filter is not available yet, and using this argument returns an error.
sensitiveData [VulnerabilitySensitiveDataFilter!] Introduced as an experiment in GitLab 19.6.

Filter vulnerabilities by whether their component handles sensitive data. Maximum is 1000 values. This filter is not available yet, and using this argument returns an error.
severity [VulnerabilitySeverity!] Filter vulnerabilities by severity.
sort VulnerabilitySort List vulnerabilities by sort order. severity_desc
state [VulnerabilityState!] Filter vulnerabilities by state.
trackedRefIds [SecurityProjectTrackedContextID!] Introduced as an experiment in GitLab 18.10.

Filter vulnerabilities by tracked ref IDs. To use this argument, you must have advanced search configured and advanced vulnerability management set up.
trackedRefsScope SecurityTrackedRefScope Introduced as an experiment in GitLab 18.9.

Filter by tracked ref scope. To use this argument, you must have advanced search configured and advanced vulnerability management set up and the vulnerabilities_across_contexts feature flag enabled.
validityCheck [VulnerabilityFindingTokenStatusState!] Introduced as an experiment in GitLab 18.5.

Filter vulnerabilities by validity check.

vulnerabilitiesCountByDay

The historical number of vulnerabilities per day for the projects on the current user’s instance security dashboard. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: VulnerabilitiesCountByDayConnection

vulnerabilitiesCountByDay arguments

Name Type Description
endDate ISO8601Date! Last day for which to fetch vulnerability history.
startDate ISO8601Date! First day for which to fetch vulnerability history.

vulnerability

Find a vulnerability.

Returns: Vulnerability

vulnerability arguments

Name Type Description
id VulnerabilityID! Global ID of the Vulnerability.

wikiPage

  • Status: Experiment

Find a wiki page.

Returns: WikiPage

wikiPage arguments

Name Type Description
namespaceId NamespaceID Wiki page namespace ID.
projectId ProjectID Wiki page project ID.
slug String Wiki page slug.

workItem

  • Status: Experiment

Find a work item.

Returns: WorkItem

workItem arguments

Name Type Description
id WorkItemID! Global ID of the work item.

workItemAllowedStatuses

  • Status: Experiment

Allowed work item statuses from the root groups the current user belongs to. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: WorkItemStatusConnection

workItemAllowedStatuses arguments

Name Type Description
name String Filter statuses by name.

workItemDescriptionTemplateContent

  • Status: Experiment

Find a work item description template.

Returns: WorkItemDescriptionTemplate

workItemDescriptionTemplateContent arguments

Name Type Description
templateContentInput WorkItemDescriptionTemplateContentInput! Input for fetching a specific description template.

workItemTypeIconDefinitions

  • Status: Experiment

Available icon definitions for work item types.

Returns: [WorkItemTypeIconDefinition!]!

workItemsByReference

  • Status: Experiment

Find work items by their reference. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: WorkItemConnection

workItemsByReference arguments

Name Type Description
contextNamespacePath ID Full path of the context namespace (project or group).
refs [String!]! Work item references. Can be either a short reference or URL.

workspace

Find a workspace.

Returns: Workspace

workspace arguments

Name Type Description
id RemoteDevelopmentWorkspaceID! Find a workspace by its ID.

workspaces

Find workspaces across the entire instance. This field is only available to instance admins, it will return an empty result for all non-admins. This field is a connection and accepts the four standard pagination arguments: before, after, first, last.

Returns: WorkspaceConnection

workspaces arguments

Name Type Description
actualStates [String!] Filter workspaces by actual states.
agentIds [ClustersAgentID!] Filter workspaces by agent GlobalIDs.
ids [RemoteDevelopmentWorkspaceID!] Filter workspaces by workspace GlobalIDs. For example, ["gid://gitlab/RemoteDevelopment::Workspace/1"].
includeActualStates [String!] Deprecated in GitLab 16.7. Use actual_states instead.
projectIds [ProjectID!] Filter workspaces by project GlobalIDs.
userIds [ProjectID!] Filter workspaces by user GlobalIDs.