GraphQL API Resources

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

The API can be explored interactively using the GraphiQL IDE.

Objects

AddAwardEmojiPayload

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

AwardEmoji

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

Blob

NameTypeDescription
idID! 
shaString!Last commit sha for entry
nameString! 
typeEntryType! 
pathString! 
flatPathString! 
webUrlString 
lfsOidString 

Commit

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

CreateDiffNotePayload

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

CreateEpicPayload

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

CreateImageDiffNotePayload

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

CreateNotePayload

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

Design

NameTypeDescription
idID! 
projectProject! 
issueIssue! 
notesCountInt!The total count of user-created notes for this design
filenameString! 
fullPathString! 
eventDesignVersionEvent!The change that happened to the design at this version
imageString! 
diffRefsDiffRefs! 

DesignCollection

NameTypeDescription
projectProject! 
issueIssue! 

DesignManagementDeletePayload

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

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

DesignVersion

NameTypeDescription
idID! 
shaID! 

DestroyNotePayload

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

DetailedStatus

NameTypeDescription
groupString! 
iconString! 
faviconString! 
detailsPathString! 
hasDetailsBoolean! 
labelString! 
textString! 
tooltipString! 

DiffPosition

NameTypeDescription
diffRefsDiffRefs! 
filePathString!The path of the file that was changed
oldPathStringThe path of the file on the start sha.
newPathStringThe path of the file on the head sha.
positionTypeDiffPositionType! 
oldLineIntThe line on start sha that was changed
newLineIntThe line on head sha that was changed
xIntThe X postion on which the comment was made
yIntThe Y position on which the comment was made
widthIntThe total width of the image
heightIntThe total height of the image

DiffRefs

NameTypeDescription
headShaString!The sha of the head at the time the comment was made
baseShaString!The merge base of the branch the comment was made on
startShaString!The sha of the branch being compared against

Discussion

NameTypeDescription
idID! 
replyIdID!The ID used to reply to this discussion
createdAtTime! 

Epic

NameTypeDescription
userPermissionsEpicPermissions!Permissions for the current user on the resource
idID!ID of the epic
iidID!Internal ID of the epic
titleStringTitle of the epic
descriptionStringDescription of the epic
stateEpicState!State of the epic
groupGroup!Group to which the epic belongs
parentEpicParent epic of the epic
authorUser!Author of the epic
startDateTimeStart date of the epic
startDateIsFixedBooleanIndicates if the start date has been manually set
startDateFixedTimeFixed start date of the epic
startDateFromMilestonesTimeInherited start date of the epic from milestones
dueDateTimeDue date of the epic
dueDateIsFixedBooleanIndicates if the due date has been manually set
dueDateFixedTimeFixed due date of the epic
dueDateFromMilestonesTimeInherited due date of the epic from milestones
upvotesInt!Number of upvotes the epic has received
downvotesInt!Number of downvotes the epic has received
closedAtTimeTimestamp of the epic’s closure
createdAtTimeTimestamp of the epic’s creation
updatedAtTimeTimestamp of the epic’s last activity
hasChildrenBoolean!Indicates if the epic has children
hasIssuesBoolean!Indicates if the epic has direct issues
webPathString! 
webUrlString! 
relativePositionIntThe relative position of the epic in the epic tree
relationPathString 
referenceString! 
subscribedBoolean!Boolean flag for whether the currently logged in user is subscribed to this epic
descendantCountsEpicDescendantCountNumber of open and closed descendant epics and issues

EpicDescendantCount

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

EpicIssue

NameTypeDescription
userPermissionsIssuePermissions!Permissions for the current user on the resource
iidID!Internal ID of the issue
titleString!Title of the issue
titleHtmlStringThe GitLab Flavored Markdown rendering of title
descriptionStringDescription of the issue
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
stateIssueState!State of the issue
referenceString!Internal reference of the issue. Returned in shortened format by default
authorUser!User that created the issue
milestoneMilestoneMilestone of the issue
dueDateTimeDue date of the issue
confidentialBoolean!Indicates the issue is confidential
discussionLockedBoolean!Indicates discussion is locked on the issue
upvotesInt!Number of upvotes the issue has received
downvotesInt!Number of downvotes the issue has received
userNotesCountInt!Number of user notes of the issue
webPathString!Web path of the issue
webUrlString!Web URL of the issue
relativePositionIntRelative position of the issue (used for positioning in epic tree and issue boards)
subscribedBoolean!Boolean flag for whether the currently logged in user is subscribed to this issue
timeEstimateInt!Time estimate of the issue
totalTimeSpentInt!Total time reported as spent on the issue
closedAtTimeTimestamp of when the issue was closed
createdAtTime!Timestamp of when the issue was created
updatedAtTime!Timestamp of when the issue was last updated
taskCompletionStatusTaskCompletionStatus!Task completion status of the issue
epicEpicThe epic to which issue belongs
weightInt 
designsDesignCollection 
designCollectionDesignCollection 
epicIssueIdID! 
relationPathString 
idIDThe global id of the epic-issue relation

EpicPermissions

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

EpicSetSubscriptionPayload

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

EpicTreeReorderPayload

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

Group

NameTypeDescription
idID!ID of the namespace
nameString!Name of the namespace
pathString!Path of the namespace
fullNameString!Full name of the namespace
fullPathID!Full path of the namespace
descriptionStringDescription of the namespace
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
visibilityStringVisibility of the namespace
lfsEnabledBooleanIndicates if Large File Storage (LFS) is enabled for namespace
requestAccessEnabledBooleanIndicates if users can request access to namespace
rootStorageStatisticsRootStorageStatisticsAggregated storage statistics of the namespace. Only available for root namespaces
userPermissionsGroupPermissions!Permissions for the current user on the resource
webUrlString!Web URL of the group
avatarUrlStringAvatar URL of the group
parentGroupParent group
epicsEnabledBooleanIndicates if Epics are enabled for namespace
groupTimelogsEnabledBooleanIndicates if Group timelogs are enabled for namespace
epicEpic 

GroupPermissions

NameTypeDescription
readGroupBoolean!Whether or not a user can perform read_group on this resource

Issue

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

IssuePermissions

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

IssueSetConfidentialPayload

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

IssueSetDueDatePayload

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

Label

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

MergeRequest

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

MergeRequestPermissions

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

MergeRequestSetAssigneesPayload

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

MergeRequestSetLabelsPayload

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

MergeRequestSetLockedPayload

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

MergeRequestSetMilestonePayload

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

MergeRequestSetSubscriptionPayload

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

MergeRequestSetWipPayload

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

Metadata

NameTypeDescription
versionString!Version
revisionString!Revision

Milestone

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

Namespace

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

Note

NameTypeDescription
userPermissionsNotePermissions!Permissions for the current user on the resource
idID! 
projectProjectThe project this note is associated to
authorUser!The user who wrote this note
resolvedByUserThe user that resolved the discussion
systemBoolean!Whether or not this note was created by the system or by a user
bodyString!The content note itself
bodyHtmlStringThe GitLab Flavored Markdown rendering of note
createdAtTime! 
updatedAtTime! 
discussionDiscussionThe discussion this note is a part of
resolvableBoolean! 
resolvedAtTimeThe time the discussion was resolved
positionDiffPositionThe position of this note on a diff

NotePermissions

NameTypeDescription
readNoteBoolean!Whether or not a user can perform read_note on this resource
createNoteBoolean!Whether or not a user can perform create_note on this resource
adminNoteBoolean!Whether or not a user can perform admin_note on this resource
resolveNoteBoolean!Whether or not a user can perform resolve_note on this resource
awardEmojiBoolean!Whether or not a user can perform award_emoji on this resource

PageInfo

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

Pipeline

NameTypeDescription
userPermissionsPipelinePermissions!Permissions for the current user on the resource
idID! 
iidString! 
shaString! 
beforeShaString 
statusPipelineStatusEnum! 
detailedStatusDetailedStatus! 
durationIntDuration of the pipeline in seconds
coverageFloatCoverage percentage
createdAtTime! 
updatedAtTime! 
startedAtTime 
finishedAtTime 
committedAtTime 

PipelinePermissions

NameTypeDescription
updatePipelineBoolean!Whether or not a user can perform update_pipeline on this resource
adminPipelineBoolean!Whether or not a user can perform admin_pipeline on this resource
destroyPipelineBoolean!Whether or not a user can perform destroy_pipeline on this resource

Project

NameTypeDescription
userPermissionsProjectPermissions!Permissions for the current user on the resource
idID!ID of the project
fullPathID!Full path of the project
pathString!Path of the project
nameWithNamespaceString!Full name of the project with its namespace
nameString!Name of the project (without namespace)
descriptionStringShort description of the project
descriptionHtmlStringThe GitLab Flavored Markdown rendering of description
tagListStringList of project tags
sshUrlToRepoStringURL to connect to the project via SSH
httpUrlToRepoStringURL to connect to the project via HTTPS
webUrlStringWeb URL of the project
starCountInt!Number of times the project has been starred
forksCountInt!Number of times the project has been forked
createdAtTimeTimestamp of the project creation
lastActivityAtTimeTimestamp of the project last activity
archivedBooleanArchived status of the project
visibilityStringVisibility of the project
containerRegistryEnabledBooleanIndicates if the project stores Docker container images in a container registry
sharedRunnersEnabledBooleanIndicates if shared runners are enabled on the project
lfsEnabledBooleanIndicates if the project has Large File Storage (LFS) enabled
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.
avatarUrlStringURL to avatar image file of the project
issuesEnabledBoolean(deprecated) Does this project have issues enabled?. Use issues_access_level instead
mergeRequestsEnabledBoolean(deprecated) Does this project have merge_requests enabled?. Use merge_requests_access_level instead
wikiEnabledBoolean(deprecated) Does this project have wiki enabled?. Use wiki_access_level instead
snippetsEnabledBoolean(deprecated) Does this project have snippets enabled?. Use snippets_access_level instead
jobsEnabledBoolean(deprecated) Enable jobs for this project. Use builds_access_level instead
publicJobsBooleanIndicates if there is public access to pipelines and job details of the project, including output logs and artifacts
openIssuesCountIntNumber of open issues for the project
importStatusStringStatus of project import background job of the project
onlyAllowMergeIfPipelineSucceedsBooleanIndicates if merge requests of the project can only be merged with successful jobs
requestAccessEnabledBooleanIndicates if users can request member access to the project
onlyAllowMergeIfAllDiscussionsAreResolvedBooleanIndicates if merge requests of the project can only be merged when all the discussions are resolved
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
removeSourceBranchAfterMergeBooleanIndicates if Delete source branch option should be enabled by default for all new merge requests of the project
namespaceNamespaceNamespace of the project
groupGroupGroup of the project
statisticsProjectStatisticsStatistics of the project
repositoryRepositoryGit repository of the project
mergeRequestMergeRequestA single merge request of the project
issueIssueA single issue of the project
sentryDetailedErrorSentryDetailedErrorDetailed version of a Sentry error on the project
serviceDeskEnabledBooleanIndicates if the project has service desk enabled.
serviceDeskAddressStringE-mail address of the service desk.

ProjectPermissions

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

ProjectStatistics

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

RemoveAwardEmojiPayload

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

Repository

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

RootStorageStatistics

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

SentryDetailedError

NameTypeDescription
idID!ID (global ID) of the error
sentryIdString!ID (Sentry ID) of the error
titleString!Title of the error
typeString!Type of the error
userCountInt!Count of users affected by the error
countInt!Count of occurrences
firstSeenTime!Timestamp when the error was first seen
lastSeenTime!Timestamp when the error was last seen
messageStringSentry metadata message of the error
culpritString!Culprit of the error
externalUrlString!External URL 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
frequencySentryErrorFrequency! => ArrayLast 24hr stats of the error
firstReleaseLastCommitStringCommit the error was first seen
lastReleaseLastCommitStringCommit the error was last seen
firstReleaseShortVersionStringRelease version the error was first seen
lastReleaseShortVersionStringRelease version the error was last seen

SentryErrorFrequency

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

Snippet

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

SnippetPermissions

NameTypeDescription
createNoteBoolean!Whether or not a user can perform create_note on this resource
awardEmojiBoolean!Whether or not a user can perform award_emoji on this resource
readSnippetBoolean!Whether or not a user can perform read_snippet on this resource
updateSnippetBoolean!Whether or not a user can perform update_snippet on this resource
adminSnippetBoolean!Whether or not a user can perform admin_snippet on this resource

Submodule

NameTypeDescription
idID! 
shaString!Last commit sha for entry
nameString! 
typeEntryType! 
pathString! 
flatPathString! 
webUrlString 
treeUrlString 

TaskCompletionStatus

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

Timelog

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

Todo

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

TodoMarkDonePayload

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

TodoRestorePayload

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

TodosMarkAllDonePayload

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

ToggleAwardEmojiPayload

NameTypeDescription
clientMutationIdStringA unique identifier for the client performing the mutation.
errorsString! => ArrayReasons why the mutation failed.
awardEmojiAwardEmojiThe award emoji after mutation
toggledOnBoolean!True when the emoji was awarded, false when it was removed

Tree

NameTypeDescription
lastCommitCommitLast commit for the tree

TreeEntry

NameTypeDescription
idID! 
shaString!Last commit sha for entry
nameString! 
typeEntryType! 
pathString! 
flatPathString! 
webUrlString 

UpdateEpicPayload

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

UpdateNotePayload

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

User

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

UserPermissions

NameTypeDescription
createSnippetBoolean!Whether or not a user can perform create_snippet on this resource