GraphQL API Resources

This documentation is self-generated based on GitLab current GraphQL schema.

The API can be explored interactively using the GraphiQL IDE.

Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL.

AddAwardEmojiPayload

Autogenerated return type of AddAwardEmoji

NameTypeDescription
awardEmojiAwardEmojiThe award emoji after mutation
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.

AwardEmoji

An emoji awarded by a user.

NameTypeDescription
descriptionString!The emoji description
emojiString!The emoji as an icon
nameString!The emoji name
unicodeString!The emoji in unicode
unicodeVersionString!The unicode version for this emoji
userUser!The user who awarded the emoji

Blob

NameTypeDescription
flatPathString!Flat path of the entry
idID!ID of the entry
lfsOidStringLFS ID of the blob
nameString!Name of the entry
pathString!Path of the entry
shaString!Last commit sha for the entry
typeEntryType!Type of tree entry
webUrlStringWeb URL of the blob

Board

Represents a project or group board

NameTypeDescription
idID!ID (global ID) of the board
nameStringName of the board
weightIntWeight of the board

Commit

NameTypeDescription
authorUserAuthor of the commit
authorGravatarStringCommit authors gravatar
authorNameStringCommit authors name
authoredDateTimeTimestamp of when the commit was authored
descriptionStringDescription of the commit message
idID!ID (global ID) of the commit
latestPipelinePipelineLatest pipeline of the commit
messageStringRaw commit message
shaString!SHA1 ID of the commit
signatureHtmlStringRendered HTML of the commit signature
titleStringTitle of the commit message
webUrlString!Web URL of the commit

CreateDiffNotePayload

Autogenerated return type of CreateDiffNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

CreateEpicPayload

Autogenerated return type of CreateEpic

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicThe created epic
errorsString! => ArrayReasons why the mutation failed.

CreateImageDiffNotePayload

Autogenerated return type of CreateImageDiffNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

CreateNotePayload

Autogenerated return type of CreateNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

CreateSnippetPayload

Autogenerated return type of CreateSnippet

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
snippetSnippetThe snippet after mutation

Design

A single design

NameTypeDescription
diffRefsDiffRefs!The diff refs for this design
eventDesignVersionEvent!How this design was changed in the current version
filenameString!The filename of the design
fullPathString!The full path to the design file
idID!The ID of this design
imageString!The URL of the image
issueIssue!The issue the design belongs to
notesCountInt!The total count of user-created notes for this design
projectProject!The project the design belongs to

DesignAtVersion

A design pinned to a specific version. The image field reflects the design as of the associated version.

NameTypeDescription
designDesign!The underlying design.
diffRefsDiffRefs!The diff refs for this design
eventDesignVersionEvent!How this design was changed in the current version
filenameString!The filename of the design
fullPathString!The full path to the design file
idID!The ID of this design
imageString!The URL of the image
issueIssue!The issue the design belongs to
notesCountInt!The total count of user-created notes for this design
projectProject!The project the design belongs to
versionDesignVersion!The version this design-at-versions is pinned to

DesignCollection

A collection of designs.

NameTypeDescription
designDesignFind a specific design
designAtVersionDesignAtVersionFind a design as of a version
issueIssue!Issue associated with the design collection
projectProject!Project associated with the design collection
versionDesignVersionA specific version

DesignManagement

NameTypeDescription
designAtVersionDesignAtVersionFind a design as of a version
versionDesignVersionFind a version

DesignManagementDeletePayload

Autogenerated return type of DesignManagementDelete

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
versionDesignVersionThe new version in which the designs are deleted

DesignManagementUploadPayload

Autogenerated return type of DesignManagementUpload

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
designsDesign! => ArrayThe designs that were uploaded by the mutation
errorsString! => ArrayReasons why the mutation failed.
skippedDesignsDesign! => ArrayAny designs that were skipped from the upload due to there being no change to their content since their last version

DesignVersion

A specific version in which designs were added, modified or deleted

NameTypeDescription
designAtVersionDesignAtVersion!A particular design as of this version, provided it is visible at this version
idID!ID of the design version
shaID!SHA of the design version

DestroyNotePayload

Autogenerated return type of DestroyNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

DestroySnippetPayload

Autogenerated return type of DestroySnippet

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
snippetSnippetThe snippet after mutation

DetailedStatus

NameTypeDescription
detailsPathString!Path of the details for the pipeline status
faviconString!Favicon of the pipeline status
groupString!Group of the pipeline status
hasDetailsBoolean!Indicates if the pipeline status has further details
iconString!Icon of the pipeline status
labelString!Label of the pipeline status
textString!Text of the pipeline status
tooltipString!Tooltip associated with the pipeline status

DiffPosition

NameTypeDescription
diffRefsDiffRefs!Information about the branch, HEAD, and base at the time of commenting
filePathString!Path of the file that was changed
heightIntTotal height of the image
newLineIntLine on HEAD SHA that was changed
newPathStringPath of the file on the HEAD SHA
oldLineIntLine on start SHA that was changed
oldPathStringPath of the file on the start SHA
positionTypeDiffPositionType!Type of file the position refers to
widthIntTotal width of the image
xIntX position of the note
yIntY position of the note

DiffRefs

NameTypeDescription
baseShaString!Merge base of the branch the comment was made on
headShaString!SHA of the HEAD at the time the comment was made
startShaString!SHA of the branch being compared against

Discussion

NameTypeDescription
createdAtTime!Timestamp of the discussion’s creation
idID!ID of this discussion
replyIdID!ID used to reply to this discussion

Environment

Describes where code is deployed for a project

NameTypeDescription
idID!ID of the environment
nameString!Human-readable name of the environment

Epic

Represents an epic.

NameTypeDescription
authorUser!Author of the epic
closedAtTimeTimestamp of the epic’s closure
createdAtTimeTimestamp of the epic’s creation
descendantCountsEpicDescendantCountNumber of open and closed descendant epics and issues
descriptionStringDescription of the epic
downvotesInt!Number of downvotes the epic has received
dueDateTimeDue date of the epic
dueDateFixedTimeFixed due date of the epic
dueDateFromMilestonesTimeInherited due date of the epic from milestones
dueDateIsFixedBooleanIndicates if the due date has been manually set
groupGroup!Group to which the epic belongs
hasChildrenBoolean!Indicates if the epic has children
hasIssuesBoolean!Indicates if the epic has direct issues
healthStatusHealthStatusCurrent health status. Available only when feature flag save_issuable_health_status is enabled.
idID!ID of the epic
iidID!Internal ID of the epic
parentEpicParent epic of the epic
referenceString!Internal reference of the epic. Returned in shortened format by default
relationPathStringURI path of the epic-issue relationship
relativePositionIntThe relative position of the epic in the epic tree
startDateTimeStart date of the epic
startDateFixedTimeFixed start date of the epic
startDateFromMilestonesTimeInherited start date of the epic from milestones
startDateIsFixedBooleanIndicates if the start date has been manually set
stateEpicState!State of the epic
subscribedBoolean!Indicates the currently logged in user is subscribed to the epic
titleStringTitle of the epic
updatedAtTimeTimestamp of the epic’s last activity
upvotesInt!Number of upvotes the epic has received
userPermissionsEpicPermissions!Permissions for the current user on the resource
webPathString!Web path of the epic
webUrlString!Web URL of the epic

EpicDescendantCount

Counts of descendent epics.

NameTypeDescription
closedEpicsIntNumber of closed sub-epics
closedIssuesIntNumber of closed epic issues
openedEpicsIntNumber of opened sub-epics
openedIssuesIntNumber of opened epic issues

EpicIssue

Relationship between an epic and an issue

NameTypeDescription
authorUser!User that created the issue
closedAtTimeTimestamp of when the issue was closed
confidentialBoolean!Indicates the issue is confidential
createdAtTime!Timestamp of when the issue was created
descriptionStringDescription of the issue
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
designCollectionDesignCollectionCollection of design images associated with this issue
designsDesignCollectionDeprecated. Use designCollection
discussionLockedBoolean!Indicates discussion is locked on the issue
downvotesInt!Number of downvotes the issue has received
dueDateTimeDue date of the issue
epicEpicEpic to which this issue belongs
epicIssueIdID!ID of the epic-issue relation
healthStatusHealthStatusCurrent health status. Available only when feature flag save_issuable_health_status is enabled.
idIDGlobal ID of the epic-issue relation
iidID!Internal ID of the issue
milestoneMilestoneMilestone of the issue
referenceString!Internal reference of the issue. Returned in shortened format by default
relationPathStringURI path of the epic-issue relation
relativePositionIntRelative position of the issue (used for positioning in epic tree and issue boards)
stateIssueState!State of the issue
subscribedBoolean!Indicates the currently logged in user is subscribed to the issue
taskCompletionStatusTaskCompletionStatus!Task completion status of the issue
timeEstimateInt!Time estimate of the issue
titleString!Title of the issue
titleHtmlStringThe GitLab Flavored Markdown rendering of title
totalTimeSpentInt!Total time reported as spent on the issue
updatedAtTime!Timestamp of when the issue was last updated
upvotesInt!Number of upvotes the issue has received
userNotesCountInt!Number of user notes of the issue
userPermissionsIssuePermissions!Permissions for the current user on the resource
webPathString!Web path of the issue
webUrlString!Web URL of the issue
weightIntWeight of the issue

EpicPermissions

Check permissions for the current user on an epic

NameTypeDescription
adminEpicBoolean!Indicates the user can perform admin_epic on this resource
awardEmojiBoolean!Indicates the user can perform award_emoji on this resource
createEpicBoolean!Indicates the user can perform create_epic on this resource
createNoteBoolean!Indicates the user can perform create_note on this resource
destroyEpicBoolean!Indicates the user can perform destroy_epic on this resource
readEpicBoolean!Indicates the user can perform read_epic on this resource
readEpicIidBoolean!Indicates the user can perform read_epic_iid on this resource
updateEpicBoolean!Indicates the user can perform update_epic on this resource

EpicSetSubscriptionPayload

Autogenerated return type of EpicSetSubscription

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicThe epic after mutation
errorsString! => ArrayReasons why the mutation failed.

EpicTreeReorderPayload

Autogenerated return type of EpicTreeReorder

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.

GrafanaIntegration

NameTypeDescription
createdAtTime!Timestamp of the issue’s creation
enabledBoolean!Indicates whether Grafana integration is enabled
grafanaUrlString!Url for the Grafana host for the Grafana integration
idID!Internal ID of the Grafana integration
tokenString!API token for the Grafana integration. Field is permanently masked.
updatedAtTime!Timestamp of the issue’s last activity

Group

NameTypeDescription
autoDevopsEnabledBooleanIndicates whether Auto DevOps is enabled for all projects within this group
avatarUrlStringAvatar URL of the group
descriptionStringDescription of the namespace
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
emailsDisabledBooleanIndicates if a group has email notifications disabled
epicEpicFind a single epic
epicsEnabledBooleanIndicates if Epics are enabled for namespace
fullNameString!Full name of the namespace
fullPathID!Full path of the namespace
groupTimelogsEnabledBooleanIndicates if Group timelogs are enabled for namespace
idID!ID of the namespace
lfsEnabledBooleanIndicates if Large File Storage (LFS) is enabled for namespace
mentionsDisabledBooleanIndicates if a group is disabled from getting mentioned
nameString!Name of the namespace
parentGroupParent group
pathString!Path of the namespace
projectCreationLevelStringThe permission level required to create projects in the group
requestAccessEnabledBooleanIndicates if users can request access to namespace
requireTwoFactorAuthenticationBooleanIndicates if all users in this group are required to set up two-factor authentication
rootStorageStatisticsRootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces
shareWithGroupLockBooleanIndicates if sharing a project with another group within this group is prevented
subgroupCreationLevelStringThe permission level required to create subgroups within the group
twoFactorGracePeriodIntTime before two-factor authentication is enforced
userPermissionsGroupPermissions!Permissions for the current user on the resource
visibilityStringVisibility of the namespace
webUrlString!Web URL of the group

GroupPermissions

NameTypeDescription
readGroupBoolean!Indicates the user can perform read_group on this resource

Issue

NameTypeDescription
authorUser!User that created the issue
closedAtTimeTimestamp of when the issue was closed
confidentialBoolean!Indicates the issue is confidential
createdAtTime!Timestamp of when the issue was created
descriptionStringDescription of the issue
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
designCollectionDesignCollectionCollection of design images associated with this issue
designsDesignCollectionDeprecated. Use designCollection
discussionLockedBoolean!Indicates discussion is locked on the issue
downvotesInt!Number of downvotes the issue has received
dueDateTimeDue date of the issue
epicEpicEpic to which this issue belongs
healthStatusHealthStatusCurrent health status. Available only when feature flag save_issuable_health_status is enabled.
iidID!Internal ID of the issue
milestoneMilestoneMilestone of the issue
referenceString!Internal reference of the issue. Returned in shortened format by default
relativePositionIntRelative position of the issue (used for positioning in epic tree and issue boards)
stateIssueState!State of the issue
subscribedBoolean!Indicates the currently logged in user is subscribed to the issue
taskCompletionStatusTaskCompletionStatus!Task completion status of the issue
timeEstimateInt!Time estimate of the issue
titleString!Title of the issue
titleHtmlStringThe GitLab Flavored Markdown rendering of title
totalTimeSpentInt!Total time reported as spent on the issue
updatedAtTime!Timestamp of when the issue was last updated
upvotesInt!Number of upvotes the issue has received
userNotesCountInt!Number of user notes of the issue
userPermissionsIssuePermissions!Permissions for the current user on the resource
webPathString!Web path of the issue
webUrlString!Web URL of the issue
weightIntWeight of the issue

IssuePermissions

Check permissions for the current user on a issue

NameTypeDescription
adminIssueBoolean!Indicates the user can perform admin_issue on this resource
createDesignBoolean!Indicates the user can perform create_design on this resource
createNoteBoolean!Indicates the user can perform create_note on this resource
destroyDesignBoolean!Indicates the user can perform destroy_design on this resource
readDesignBoolean!Indicates the user can perform read_design on this resource
readIssueBoolean!Indicates the user can perform read_issue on this resource
reopenIssueBoolean!Indicates the user can perform reopen_issue on this resource
updateIssueBoolean!Indicates the user can perform update_issue on this resource

IssueSetConfidentialPayload

Autogenerated return type of IssueSetConfidential

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
issueIssueThe issue after mutation

IssueSetDueDatePayload

Autogenerated return type of IssueSetDueDate

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
issueIssueThe issue after mutation

IssueSetWeightPayload

Autogenerated return type of IssueSetWeight

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
issueIssueThe issue after mutation

Label

NameTypeDescription
colorString!Background color of the label
descriptionStringDescription of the label (Markdown rendered as HTML for caching)
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
idID!Label ID
textColorString!Text color of the label
titleString!Content of the label

MarkAsSpamSnippetPayload

Autogenerated return type of MarkAsSpamSnippet

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
snippetSnippetThe snippet after mutation

MergeRequest

NameTypeDescription
allowCollaborationBooleanIndicates if members of the target project can push to the fork
createdAtTime!Timestamp of when the merge request was created
defaultMergeCommitMessageStringDefault merge commit message of the merge request
descriptionStringDescription of the merge request (Markdown rendered as HTML for caching)
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
diffHeadShaStringDiff head SHA of the merge request
diffRefsDiffRefsReferences of the base SHA, the head SHA, and the start SHA for this merge request
discussionLockedBoolean!Indicates if comments on the merge request are locked to members only
downvotesInt!Number of downvotes for the merge request
forceRemoveSourceBranchBooleanIndicates if the project settings will lead to source branch deletion after merge
headPipelinePipelineThe pipeline running on the branch HEAD of the merge request
idID!ID of the merge request
iidString!Internal ID of the merge request
inProgressMergeCommitShaStringCommit SHA of the merge request if merge is in progress
mergeCommitMessageStringDeprecated - renamed to defaultMergeCommitMessage
mergeCommitShaStringSHA of the merge request commit (set once merged)
mergeErrorStringError message due to a merge error
mergeOngoingBoolean!Indicates if a merge is currently occurring
mergeStatusStringStatus of the merge request
mergeWhenPipelineSucceedsBooleanIndicates if the merge has been set to be merged when its pipeline succeeds (MWPS)
mergeableDiscussionsStateBooleanIndicates if all discussions in the merge request have been resolved, allowing the merge request to be merged
milestoneMilestoneThe milestone of the merge request
projectProject!Alias for target_project
projectIdInt!ID of the merge request project
rebaseCommitShaStringRebase commit SHA of the merge request
rebaseInProgressBoolean!Indicates if there is a rebase currently in progress for the merge request
referenceString!Internal reference of the merge request. Returned in shortened format by default
shouldBeRebasedBoolean!Indicates if the merge request will be rebased
shouldRemoveSourceBranchBooleanIndicates if the source branch of the merge request will be deleted after merge
sourceBranchString!Source branch of the merge request
sourceBranchExistsBoolean!Indicates if the source branch of the merge request exists
sourceProjectProjectSource project of the merge request
sourceProjectIdIntID of the merge request source project
stateMergeRequestState!State of the merge request
subscribedBoolean!Indicates if the currently logged in user is subscribed to this merge request
targetBranchString!Target branch of the merge request
targetProjectProject!Target project of the merge request
targetProjectIdInt!ID of the merge request target project
taskCompletionStatusTaskCompletionStatus!Completion status of tasks
timeEstimateInt!Time estimate of the merge request
titleString!Title of the merge request
titleHtmlStringThe GitLab Flavored Markdown rendering of title
totalTimeSpentInt!Total time reported as spent on the merge request
updatedAtTime!Timestamp of when the merge request was last updated
upvotesInt!Number of upvotes for the merge request
userNotesCountIntUser notes count of the merge request
userPermissionsMergeRequestPermissions!Permissions for the current user on the resource
webUrlStringWeb URL of the merge request
workInProgressBoolean!Indicates if the merge request is a work in progress (WIP)

MergeRequestPermissions

Check permissions for the current user on a merge request

NameTypeDescription
adminMergeRequestBoolean!Indicates the user can perform admin_merge_request on this resource
cherryPickOnCurrentMergeRequestBoolean!Indicates the user can perform cherry_pick_on_current_merge_request on this resource
createNoteBoolean!Indicates the user can perform create_note on this resource
pushToSourceBranchBoolean!Indicates the user can perform push_to_source_branch on this resource
readMergeRequestBoolean!Indicates the user can perform read_merge_request on this resource
removeSourceBranchBoolean!Indicates the user can perform remove_source_branch on this resource
revertOnCurrentMergeRequestBoolean!Indicates the user can perform revert_on_current_merge_request on this resource
updateMergeRequestBoolean!Indicates the user can perform update_merge_request on this resource

MergeRequestSetAssigneesPayload

Autogenerated return type of MergeRequestSetAssignees

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

MergeRequestSetLabelsPayload

Autogenerated return type of MergeRequestSetLabels

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

MergeRequestSetLockedPayload

Autogenerated return type of MergeRequestSetLocked

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

MergeRequestSetMilestonePayload

Autogenerated return type of MergeRequestSetMilestone

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

MergeRequestSetSubscriptionPayload

Autogenerated return type of MergeRequestSetSubscription

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

MergeRequestSetWipPayload

Autogenerated return type of MergeRequestSetWip

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
mergeRequestMergeRequestThe merge request after mutation

Metadata

NameTypeDescription
revisionString!Revision
versionString!Version

Milestone

Represents a milestone.

NameTypeDescription
createdAtTime!Timestamp of milestone creation
descriptionStringDescription of the milestone
dueDateTimeTimestamp of the milestone due date
idID!ID of the milestone
startDateTimeTimestamp of the milestone start date
stateMilestoneStateEnum!State of the milestone
titleString!Title of the milestone
updatedAtTime!Timestamp of last milestone update
webPathString!Web path of the milestone

Namespace

NameTypeDescription
descriptionStringDescription of the namespace
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
fullNameString!Full name of the namespace
fullPathID!Full path of the namespace
idID!ID of the namespace
lfsEnabledBooleanIndicates if Large File Storage (LFS) is enabled for namespace
nameString!Name of the namespace
pathString!Path of the namespace
requestAccessEnabledBooleanIndicates if users can request access to namespace
rootStorageStatisticsRootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces
visibilityStringVisibility of the namespace

Note

NameTypeDescription
authorUser!User who wrote this note
bodyString!Content of the note
bodyHtmlStringThe GitLab Flavored Markdown rendering of note
createdAtTime!Timestamp of the note creation
discussionDiscussionThe discussion this note is a part of
idID!ID of the note
positionDiffPositionThe position of this note on a diff
projectProjectProject associated with the note
resolvableBoolean!Indicates if this note can be resolved. That is, if it is a resolvable discussion or simply a standalone note
resolvedAtTimeTimestamp of the note’s resolution
resolvedByUserUser that resolved the discussion
systemBoolean!Indicates whether this note was created by the system or by a user
updatedAtTime!Timestamp of the note’s last activity
userPermissionsNotePermissions!Permissions for the current user on the resource

NotePermissions

NameTypeDescription
adminNoteBoolean!Indicates the user can perform admin_note on this resource
awardEmojiBoolean!Indicates the user can perform award_emoji on this resource
createNoteBoolean!Indicates the user can perform create_note on this resource
readNoteBoolean!Indicates the user can perform read_note on this resource
resolveNoteBoolean!Indicates the user can perform resolve_note on this resource

PageInfo

Information about pagination in a connection.

NameTypeDescription
endCursorStringWhen paginating forwards, the cursor to continue.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringWhen paginating backwards, the cursor to continue.

Pipeline

NameTypeDescription
beforeShaStringBase SHA of the source branch
committedAtTimeTimestamp of the pipeline’s commit
coverageFloatCoverage percentage
createdAtTime!Timestamp of the pipeline’s creation
detailedStatusDetailedStatus!Detailed status of the pipeline
durationIntDuration of the pipeline in seconds
finishedAtTimeTimestamp of the pipeline’s completion
idID!ID of the pipeline
iidString!Internal ID of the pipeline
shaString!SHA of the pipeline’s commit
startedAtTimeTimestamp when the pipeline was started
statusPipelineStatusEnum!Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED)
updatedAtTime!Timestamp of the pipeline’s last activity
userPermissionsPipelinePermissions!Permissions for the current user on the resource

PipelinePermissions

NameTypeDescription
adminPipelineBoolean!Indicates the user can perform admin_pipeline on this resource
destroyPipelineBoolean!Indicates the user can perform destroy_pipeline on this resource
updatePipelineBoolean!Indicates the user can perform update_pipeline on this resource

Project

NameTypeDescription
archivedBooleanIndicates the archived status of the project
autocloseReferencedIssuesBooleanIndicates if issues referenced by merge requests and commits within the default branch are closed automatically
avatarUrlStringURL to avatar image file of the project
containerRegistryEnabledBooleanIndicates if the project stores Docker container images in a container registry
createdAtTimeTimestamp of the project creation
descriptionStringShort description of the project
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
forksCountInt!Number of times the project has been forked
fullPathID!Full path of the project
grafanaIntegrationGrafanaIntegrationGrafana integration details for the project
groupGroupGroup of the project
httpUrlToRepoStringURL to connect to the project via HTTPS
idID!ID of the project
importStatusStringStatus of project import background job of the project
issueIssueA single issue of the project
issuesEnabledBoolean(deprecated) Does this project have issues enabled?. Use issues_access_level instead
jobsEnabledBoolean(deprecated) Enable jobs for this project. Use builds_access_level instead
lastActivityAtTimeTimestamp of the project last activity
lfsEnabledBooleanIndicates if the project has Large File Storage (LFS) enabled
mergeRequestMergeRequestA single merge request of the project
mergeRequestsEnabledBoolean(deprecated) Does this project have merge_requests enabled?. Use merge_requests_access_level instead
mergeRequestsFfOnlyEnabledBooleanIndicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded.
nameString!Name of the project (without namespace)
nameWithNamespaceString!Full name of the project with its namespace
namespaceNamespaceNamespace of the project
onlyAllowMergeIfAllDiscussionsAreResolvedBooleanIndicates if merge requests of the project can only be merged when all the discussions are resolved
onlyAllowMergeIfPipelineSucceedsBooleanIndicates if merge requests of the project can only be merged with successful jobs
openIssuesCountIntNumber of open issues for the project
pathString!Path of the project
printingMergeRequestLinkEnabledBooleanIndicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line
publicJobsBooleanIndicates if there is public access to pipelines and job details of the project, including output logs and artifacts
removeSourceBranchAfterMergeBooleanIndicates if Delete source branch option should be enabled by default for all new merge requests of the project
repositoryRepositoryGit repository of the project
requestAccessEnabledBooleanIndicates if users can request member access to the project
sentryDetailedErrorSentryDetailedErrorDetailed version of a Sentry error on the project
sentryErrorsSentryErrorCollectionPaginated collection of Sentry errors on the project
serviceDeskAddressStringE-mail address of the service desk.
serviceDeskEnabledBooleanIndicates if the project has service desk enabled.
sharedRunnersEnabledBooleanIndicates if shared runners are enabled on the project
snippetsEnabledBoolean(deprecated) Does this project have snippets enabled?. Use snippets_access_level instead
sshUrlToRepoStringURL to connect to the project via SSH
starCountInt!Number of times the project has been starred
statisticsProjectStatisticsStatistics of the project
suggestionCommitMessageStringThe commit message used to apply merge request suggestions
tagListStringList of project tags
userPermissionsProjectPermissions!Permissions for the current user on the resource
visibilityStringVisibility of the project
webUrlStringWeb URL of the project
wikiEnabledBoolean(deprecated) Does this project have wiki enabled?. Use wiki_access_level instead

ProjectPermissions

NameTypeDescription
adminOperationsBoolean!Indicates the user can perform admin_operations on this resource
adminProjectBoolean!Indicates the user can perform admin_project on this resource
adminRemoteMirrorBoolean!Indicates the user can perform admin_remote_mirror on this resource
adminWikiBoolean!Indicates the user can perform admin_wiki on this resource
archiveProjectBoolean!Indicates the user can perform archive_project on this resource
changeNamespaceBoolean!Indicates the user can perform change_namespace on this resource
changeVisibilityLevelBoolean!Indicates the user can perform change_visibility_level on this resource
createDeploymentBoolean!Indicates the user can perform create_deployment on this resource
createDesignBoolean!Indicates the user can perform create_design on this resource
createIssueBoolean!Indicates the user can perform create_issue on this resource
createLabelBoolean!Indicates the user can perform create_label on this resource
createMergeRequestFromBoolean!Indicates the user can perform create_merge_request_from on this resource
createMergeRequestInBoolean!Indicates the user can perform create_merge_request_in on this resource
createPagesBoolean!Indicates the user can perform create_pages on this resource
createPipelineBoolean!Indicates the user can perform create_pipeline on this resource
createPipelineScheduleBoolean!Indicates the user can perform create_pipeline_schedule on this resource
createSnippetBoolean!Indicates the user can perform create_snippet on this resource
createWikiBoolean!Indicates the user can perform create_wiki on this resource
destroyDesignBoolean!Indicates the user can perform destroy_design on this resource
destroyPagesBoolean!Indicates the user can perform destroy_pages on this resource
destroyWikiBoolean!Indicates the user can perform destroy_wiki on this resource
downloadCodeBoolean!Indicates the user can perform download_code on this resource
downloadWikiCodeBoolean!Indicates the user can perform download_wiki_code on this resource
forkProjectBoolean!Indicates the user can perform fork_project on this resource
pushCodeBoolean!Indicates the user can perform push_code on this resource
pushToDeleteProtectedBranchBoolean!Indicates the user can perform push_to_delete_protected_branch on this resource
readCommitStatusBoolean!Indicates the user can perform read_commit_status on this resource
readCycleAnalyticsBoolean!Indicates the user can perform read_cycle_analytics on this resource
readDesignBoolean!Indicates the user can perform read_design on this resource
readMergeRequestBoolean!Indicates the user can perform read_merge_request on this resource
readPagesContentBoolean!Indicates the user can perform read_pages_content on this resource
readProjectBoolean!Indicates the user can perform read_project on this resource
readProjectMemberBoolean!Indicates the user can perform read_project_member on this resource
readWikiBoolean!Indicates the user can perform read_wiki on this resource
removeForkProjectBoolean!Indicates the user can perform remove_fork_project on this resource
removePagesBoolean!Indicates the user can perform remove_pages on this resource
removeProjectBoolean!Indicates the user can perform remove_project on this resource
renameProjectBoolean!Indicates the user can perform rename_project on this resource
requestAccessBoolean!Indicates the user can perform request_access on this resource
updatePagesBoolean!Indicates the user can perform update_pages on this resource
updateWikiBoolean!Indicates the user can perform update_wiki on this resource
uploadFileBoolean!Indicates the user can perform upload_file on this resource

ProjectStatistics

NameTypeDescription
buildArtifactsSizeInt!Build artifacts size of the project
commitCountInt!Commit count of the project
lfsObjectsSizeInt!Large File Storage (LFS) object size of the project
packagesSizeInt!Packages size of the project
repositorySizeInt!Repository size of the project
storageSizeInt!Storage size of the project
wikiSizeIntWiki size of the project

RemoveAwardEmojiPayload

Autogenerated return type of RemoveAwardEmoji

NameTypeDescription
awardEmojiAwardEmojiThe award emoji after mutation
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.

Repository

NameTypeDescription
emptyBoolean!Indicates repository has no visible content
existsBoolean!Indicates a corresponding Git repository exists on disk
rootRefStringDefault branch of the repository
treeTreeTree of the repository

RootStorageStatistics

NameTypeDescription
buildArtifactsSizeInt!The CI artifacts size in bytes
lfsObjectsSizeInt!The LFS objects size in bytes
packagesSizeInt!The packages size in bytes
repositorySizeInt!The Git repository size in bytes
storageSizeInt!The total storage in bytes
wikiSizeInt!The wiki size in bytes

SentryDetailedError

A Sentry error.

NameTypeDescription
countInt!Count of occurrences
culpritString!Culprit of the error
externalBaseUrlString!External Base URL of the Sentry Instance
externalUrlString!External URL of the error
firstReleaseLastCommitStringCommit the error was first seen
firstReleaseShortVersionStringRelease version the error was first seen
firstSeenTime!Timestamp when the error was first seen
frequencySentryErrorFrequency! => ArrayLast 24hr stats of the error
gitlabCommitStringGitLab commit SHA attributed to the Error based on the release version
gitlabCommitPathStringPath to the GitLab page for the GitLab commit attributed to the error
gitlabIssuePathStringURL of GitLab Issue
idID!ID (global ID) of the error
lastReleaseLastCommitStringCommit the error was last seen
lastReleaseShortVersionStringRelease version the error was last seen
lastSeenTime!Timestamp when the error was last seen
messageStringSentry metadata message of the error
sentryIdString!ID (Sentry ID) of the error
sentryProjectIdID!ID of the project (Sentry project)
sentryProjectNameString!Name of the project affected by the error
sentryProjectSlugString!Slug of the project affected by the error
shortIdString!Short ID (Sentry ID) of the error
statusSentryErrorStatus!Status of the error
tagsSentryErrorTags!Tags associated with the Sentry Error
titleString!Title of the error
typeString!Type of the error
userCountInt!Count of users affected by the error

SentryError

A Sentry error. A simplified version of SentryDetailedError.

NameTypeDescription
countInt!Count of occurrences
culpritString!Culprit of the error
externalUrlString!External URL of the error
firstSeenTime!Timestamp when the error was first seen
frequencySentryErrorFrequency! => ArrayLast 24hr stats of the error
idID!ID (global ID) of the error
lastSeenTime!Timestamp when the error was last seen
messageStringSentry metadata message of the error
sentryIdString!ID (Sentry ID) of the error
sentryProjectIdID!ID of the project (Sentry project)
sentryProjectNameString!Name of the project affected by the error
sentryProjectSlugString!Slug of the project affected by the error
shortIdString!Short ID (Sentry ID) of the error
statusSentryErrorStatus!Status of the error
titleString!Title of the error
typeString!Type of the error
userCountInt!Count of users affected by the error

SentryErrorCollection

An object containing a collection of Sentry errors, and a detailed error.

NameTypeDescription
detailedErrorSentryDetailedErrorDetailed version of a Sentry error on the project
errorStackTraceSentryErrorStackTraceStack Trace of Sentry Error
errorsSentryErrorConnectionCollection of Sentry Errors
externalUrlStringExternal URL for Sentry

SentryErrorFrequency

NameTypeDescription
countInt!Count of errors received since the previously recorded time
timeTime!Time the error frequency stats were recorded

SentryErrorStackTrace

An object containing a stack trace entry for a Sentry error.

NameTypeDescription
dateReceivedString!Time the stack trace was received by Sentry
issueIdString!ID of the Sentry error
stackTraceEntriesSentryErrorStackTraceEntry! => ArrayStack trace entries for the Sentry error

SentryErrorStackTraceContext

An object context for a Sentry error stack trace

NameTypeDescription
codeString!Code number of the context
lineInt!Line number of the context

SentryErrorStackTraceEntry

An object containing a stack trace entry for a Sentry error.

NameTypeDescription
colStringFunction in which the Sentry error occurred
fileNameStringFile in which the Sentry error occurred
functionStringFunction in which the Sentry error occurred
lineStringFunction in which the Sentry error occurred
traceContextSentryErrorStackTraceContext! => ArrayContext of the Sentry error

SentryErrorTags

State of a Sentry error

NameTypeDescription
levelStringSeverity level of the Sentry Error
loggerStringLogger of the Sentry Error

Snippet

Represents a snippet entry

NameTypeDescription
authorUser!The owner of the snippet
blobSnippetBlob!Snippet blob
createdAtTime!Timestamp this snippet was created
descriptionStringDescription of the snippet
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
fileNameStringFile Name of the snippet
idID!Id of the snippet
projectProjectThe project the snippet is associated with
rawUrlString!Raw URL of the snippet
titleString!Title of the snippet
updatedAtTime!Timestamp this snippet was updated
userPermissionsSnippetPermissions!Permissions for the current user on the resource
visibilityLevelVisibilityLevelsEnum!Visibility Level of the snippet
webUrlString!Web URL of the snippet

SnippetBlob

Represents the snippet blob

NameTypeDescription
binaryBoolean!Shows whether the blob is binary
modeStringBlob mode
nameStringBlob name
pathStringBlob path
plainDataStringBlob plain highlighted data
rawPathString!Blob raw content endpoint path
richDataStringBlob highlighted data
richViewerSnippetBlobViewerBlob content rich viewer
simpleViewerSnippetBlobViewer!Blob content simple viewer
sizeInt!Blob size

SnippetBlobViewer

Represents how the blob content should be displayed

NameTypeDescription
collapsedBoolean!Shows whether the blob should be displayed collapsed
fileTypeString!Content file type
loadAsyncBoolean!Shows whether the blob content is loaded async
loadingPartialNameString!Loading partial name
renderErrorStringError rendering the blob content
tooLargeBoolean!Shows whether the blob too large to be displayed
typeBlobViewersType!Type of blob viewer

SnippetPermissions

NameTypeDescription
adminSnippetBoolean!Indicates the user can perform admin_snippet on this resource
awardEmojiBoolean!Indicates the user can perform award_emoji on this resource
createNoteBoolean!Indicates the user can perform create_note on this resource
readSnippetBoolean!Indicates the user can perform read_snippet on this resource
reportSnippetBoolean!Indicates the user can perform report_snippet on this resource
updateSnippetBoolean!Indicates the user can perform update_snippet on this resource

Submodule

NameTypeDescription
flatPathString!Flat path of the entry
idID!ID of the entry
nameString!Name of the entry
pathString!Path of the entry
shaString!Last commit sha for the entry
treeUrlStringTree URL for the sub-module
typeEntryType!Type of tree entry
webUrlStringWeb URL for the sub-module

TaskCompletionStatus

Completion status of tasks

NameTypeDescription
completedCountInt!Number of completed tasks
countInt!Number of total tasks

Timelog

NameTypeDescription
dateTime!The date when the time tracked was spent at
issueIssueThe issue that logged time was added to
timeSpentInt!The time spent displayed in seconds
userUser!The user that logged the time

Todo

Representing a todo entry

NameTypeDescription
actionTodoActionEnum!Action of the todo
authorUser!The owner of this todo
bodyString!Body of the todo
createdAtTime!Timestamp this todo was created
groupGroupGroup this todo is associated with
idID!Id of the todo
projectProjectThe project this todo is associated with
stateTodoStateEnum!State of the todo
targetTypeTodoTargetEnum!Target type of the todo

TodoMarkDonePayload

Autogenerated return type of TodoMarkDone

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
todoTodo!The requested todo

TodoRestoreManyPayload

Autogenerated return type of TodoRestoreMany

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
updatedIdsID! => ArrayThe ids of the updated todo items

TodoRestorePayload

Autogenerated return type of TodoRestore

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
todoTodo!The requested todo

TodosMarkAllDonePayload

Autogenerated return type of TodosMarkAllDone

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
updatedIdsID! => ArrayIds of the updated todos

ToggleAwardEmojiPayload

Autogenerated return type of ToggleAwardEmoji

NameTypeDescription
awardEmojiAwardEmojiThe award emoji after mutation
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
toggledOnBoolean!Indicates the status of the emoji. True if the toggle awarded the emoji, and false if the toggle removed the emoji.

Tree

NameTypeDescription
lastCommitCommitLast commit for the tree

TreeEntry

Represents a directory

NameTypeDescription
flatPathString!Flat path of the entry
idID!ID of the entry
nameString!Name of the entry
pathString!Path of the entry
shaString!Last commit sha for the entry
typeEntryType!Type of tree entry
webUrlStringWeb URL for the tree entry (directory)

UpdateEpicPayload

Autogenerated return type of UpdateEpic

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
epicEpicThe epic after mutation
errorsString! => ArrayReasons why the mutation failed.

UpdateImageDiffNotePayload

Autogenerated return type of UpdateImageDiffNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

UpdateIssuePayload

Autogenerated return type of UpdateIssue

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
issueIssueThe issue after mutation

UpdateNotePayload

Autogenerated return type of UpdateNote

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
noteNoteThe note after mutation

UpdateSnippetPayload

Autogenerated return type of UpdateSnippet

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
snippetSnippetThe snippet after mutation

User

NameTypeDescription
avatarUrlString!URL of the user’s avatar
nameString!Human-readable name of the user
userPermissionsUserPermissions!Permissions for the current user on the resource
usernameString!Username of the user. Unique within this instance of GitLab
webUrlString!Web URL of the user

UserPermissions

NameTypeDescription
createSnippetBoolean!Indicates the user can perform create_snippet on this resource