This version of GitHub Enterprise will be discontinued on This version of GitHub Enterprise was discontinued on 2020-08-20. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Article version: Enterprise Server 2.18

Objects

In this article

About objects

Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.

For example, the Repository object has a field called name, which is a String.

For more information, see "Introduction to GraphQL."

ActorLocation

Location information for an actor.

Preview notice

ActorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

city (String)

City.

country (String)

Country name.

countryCode (String)

Country code.

region (String)

Region name.

regionCode (String)

Region or state code.


AddedToProjectEvent

Represents aadded_to_projectevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

project (Project)

Project referenced by event.

Preview notice

project is available under the Project event details preview. During the preview period, the API may change without notice.

projectCard (ProjectCard)

Project card referenced by this project event.

Preview notice

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

projectColumnName (String!)

Column name referenced by this project event.

Preview notice

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.


App

A GitHub App.

Fields

Name Description

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The description of the app.

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

logoUrl (URI!)

A URL pointing to the app's logo.

Arguments

size (Int)

The size of the resulting image.

name (String!)

The name of the app.

slug (String!)

A slug based on the name of the app for use in URLs.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The URL to the app's homepage.


AssignedEvent

Represents anassignedevent on any assignable object.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

assignable (Assignable!)

Identifies the assignable associated with the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

user (User)

Identifies the user who was assigned.


BaseRefChangedEvent

Represents abase_ref_changedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.


BaseRefForcePushedEvent

Represents abase_ref_force_pushedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.


Blame

Represents a Git blame.

Fields

Name Description

ranges ([BlameRange!]!)

The list of ranges from a Git blame.


BlameRange

Represents a range of information from a Git blame.

Fields

Name Description

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is calculated as a 2-quantile and determines the length of distance between the median age of all the changes in the file and the recency of the current range's change.

commit (Commit!)

Identifies the line author.

endingLine (Int!)

The ending line for the range.

startingLine (Int!)

The starting line for the range.


Blob

Represents a Git blob.

Fields

Name Description

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

byteSize (Int!)

Byte size of Blob object.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

isBinary (Boolean!)

Indicates whether the Blob is binary or text.

isTruncated (Boolean!)

Indicates whether the contents is truncated.

oid (GitObjectID!)

The Git object ID.

repository (Repository!)

The Repository the Git object belongs to.

text (String)

UTF8 text data or null if the Blob is binary.


Bot

A special type of user which takes actions on behalf of GitHub Apps.

Fields

Name Description

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

Arguments

size (Int)

The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTTP path for this bot.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this bot.


BranchProtectionRule

A branch protection rule.

Fields

Name Description

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

creator (Actor)

The actor who created this branch protection rule.

databaseId (Int)

Identifies the primary key from the database.

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

pattern (String!)

Identifies the protection rule pattern.

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

repository (Repository)

The repository associated with this branch protection rule.

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.


BranchProtectionRuleConflict

A conflict between two branch protection rules.

Fields

Name Description

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

ref (Ref)

Identifies the branch ref that has conflicting rules.


BranchProtectionRuleConflictConnection

The connection type for BranchProtectionRuleConflict.

Fields

Name Description

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

nodes ([BranchProtectionRuleConflict])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


BranchProtectionRuleConflictEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRuleConflict)

The item at the end of the edge.


BranchProtectionRuleConnection

The connection type for BranchProtectionRule.

Fields

Name Description

edges ([BranchProtectionRuleEdge])

A list of edges.

nodes ([BranchProtectionRule])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


BranchProtectionRuleEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (BranchProtectionRule)

The item at the end of the edge.


CheckAnnotation

A single check annotation.

Preview notice

CheckAnnotation is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

blobUrl (URI!)

The path to the file that this annotation was made on.

databaseId (Int)

Identifies the primary key from the database.

location (CheckAnnotationSpan!)

The position of this annotation.

message (String!)

The annotation's message.

path (String!)

The path that this annotation was made on.

rawDetails (String)

Additional information about the annotation.

title (String)

The annotation's title.


CheckAnnotationConnection

The connection type for CheckAnnotation.

Fields

Name Description

edges ([CheckAnnotationEdge])

A list of edges.

nodes ([CheckAnnotation])

A list of nodes.

Preview notice

nodes is available under the Checks preview. During the preview period, the API may change without notice.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CheckAnnotationEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CheckAnnotation)

The item at the end of the edge.

Preview notice

node is available under the Checks preview. During the preview period, the API may change without notice.


CheckAnnotationPosition

A character position in a check annotation.

Preview notice

CheckAnnotationPosition is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

column (Int)

Column number (1 indexed).

line (Int!)

Line number (1 indexed).


CheckAnnotationSpan

An inclusive pair of positions for a check annotation.

Preview notice

CheckAnnotationSpan is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

end (CheckAnnotationPosition!)

End position (inclusive).

start (CheckAnnotationPosition!)

Start position (inclusive).


CheckRun

A check run.

Preview notice

CheckRun is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

annotations (CheckAnnotationConnection)

The check run's annotations.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

checkSuite (CheckSuite!)

The check suite that this run is a part of.

completedAt (DateTime)

Identifies the date and time when the check run was completed.

conclusion (CheckConclusionState)

The conclusion of the check run.

databaseId (Int)

Identifies the primary key from the database.

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

externalId (String)

A reference for the check run on the integrator's system.

name (String!)

The name of the check for this check run.

permalink (URI!)

The permalink to the check run summary.

repository (Repository!)

The repository associated with this check run.

resourcePath (URI!)

The HTTP path for this check run.

startedAt (DateTime)

Identifies the date and time when the check run was started.

status (CheckStatusState!)

The current status of the check run.

summary (String)

A string representing the check run's summary.

text (String)

A string representing the check run's text.

title (String)

A string representing the check run.

url (URI!)

The HTTP URL for this check run.


CheckRunConnection

The connection type for CheckRun.

Fields

Name Description

edges ([CheckRunEdge])

A list of edges.

nodes ([CheckRun])

A list of nodes.

Preview notice

nodes is available under the Checks preview. During the preview period, the API may change without notice.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CheckRunEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CheckRun)

The item at the end of the edge.

Preview notice

node is available under the Checks preview. During the preview period, the API may change without notice.


CheckSuite

A check suite.

Preview notice

CheckSuite is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

app (App)

The GitHub App which created this check suite.

branch (Ref)

The name of the branch for this check suite.

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

filterBy (CheckRunFilter)

Filters the check runs by this type.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commit (Commit!)

The commit for this check suite.

conclusion (CheckConclusionState)

The conclusion of this check suite.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

baseRefName (String)

The base ref name to filter the pull requests by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

headRefName (String)

The head ref name to filter the pull requests by.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for pull requests returned from the connection.

states ([PullRequestState!])

A list of states to filter the pull requests by.

push (Push)

The push that triggered this check suite.

repository (Repository!)

The repository associated with this check suite.

status (CheckStatusState!)

The status of this check suite.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.


CheckSuiteConnection

The connection type for CheckSuite.

Fields

Name Description

edges ([CheckSuiteEdge])

A list of edges.

nodes ([CheckSuite])

A list of nodes.

Preview notice

nodes is available under the Checks preview. During the preview period, the API may change without notice.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CheckSuiteEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CheckSuite)

The item at the end of the edge.

Preview notice

node is available under the Checks preview. During the preview period, the API may change without notice.


ClosedEvent

Represents aclosedevent on any Closable.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

closable (Closable!)

Object that was closed.

closer (Closer)

Object which triggered the creation of this event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

resourcePath (URI!)

The HTTP path for this closed event.

url (URI!)

The HTTP URL for this closed event.


CodeOfConduct

The Code of Conduct for a repository.

Fields

Name Description

body (String)

The body of the Code of Conduct.

key (String!)

The key for the Code of Conduct.

name (String!)

The formal name of the Code of Conduct.

resourcePath (URI)

The HTTP path for this Code of Conduct.

url (URI)

The HTTP URL for this Code of Conduct.


CommentDeletedEvent

Represents acomment_deletedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.


Commit

Represents a Git commit.

Fields

Name Description

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

additions (Int!)

The number of additions in this commit.

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (PullRequestOrder)

Ordering options for pull requests.

author (GitActor)

Authorship details of the commit.

authoredByCommitter (Boolean!)

Check if the committer and the author match.

authoredDate (DateTime!)

The datetime when this commit was authored.

blame (Blame!)

Fetches git blame information.

Arguments

path (String!)

The file whose Git blame information you want.

changedFiles (Int!)

The number of changed files in this commit.

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

Preview notice

checkSuites is available under the Checks preview. During the preview period, the API may change without notice.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

filterBy (CheckSuiteFilter)

Filters the check suites by this type.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

comments (CommitCommentConnection!)

Comments made on the commit.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

committedDate (DateTime!)

The datetime when this commit was committed.

committedViaWeb (Boolean!)

Check if commited via GitHub web UI.

committer (GitActor)

Committership details of the commit.

deletions (Int!)

The number of deletions in this commit.

deployments (DeploymentConnection)

The deployments associated with a commit.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

environments ([String!])

Environments to list deployments for.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (DeploymentOrder)

Ordering options for deployments returned from the connection.

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

author (CommitAuthor)

If non-null, filters history to only show commits with matching authorship.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

path (String)

If non-null, filters history to only show commits touching files under this path.

since (GitTimestamp)

Allows specifying a beginning time or date for fetching commits.

until (GitTimestamp)

Allows specifying an ending time or date for fetching commits.

message (String!)

The Git commit message.

messageBody (String!)

The Git commit message body.

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

messageHeadline (String!)

The Git commit message headline.

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

oid (GitObjectID!)

The Git object ID.

parents (CommitConnection!)

The parents of a commit.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

pushedDate (DateTime)

The datetime when this commit was pushed.

repository (Repository!)

The Repository this commit belongs to.

resourcePath (URI!)

The HTTP path for this commit.

signature (GitSignature)

Commit signing information, if present.

status (Status)

Status information for this commit.

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.

tree (Tree!)

Commit's root Tree.

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

treeUrl (URI!)

The HTTP URL for the tree of this commit.

url (URI!)

The HTTP URL for this commit.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes.


CommitComment

Represents a comment on a given Commit.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

Identifies the comment body.

bodyHTML (HTML!)

Identifies the comment body rendered to HTML.

bodyText (String!)

The body rendered to text.

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized.

path (String)

Identifies the file path associated with the comment.

position (Int)

Identifies the line position associated with the comment.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this commit comment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL permalink for this commit comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


CommitCommentConnection

The connection type for CommitComment.

Fields

Name Description

edges ([CommitCommentEdge])

A list of edges.

nodes ([CommitComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CommitCommentEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CommitComment)

The item at the end of the edge.


CommitCommentThread

A thread of comments on a commit.

Fields

Name Description

comments (CommitCommentConnection!)

The comments that exist in this thread.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commit (Commit!)

The commit the comments were made on.

path (String)

The file the comments were made on.

position (Int)

The position in the diff for the commit that the comment was made on.

repository (Repository!)

The repository associated with this node.


CommitConnection

The connection type for Commit.

Fields

Name Description

edges ([CommitEdge])

A list of edges.

nodes ([Commit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CommitContributionsByRepository

This aggregates commits made by a user within one repository.

Fields

Name Description

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (CommitContributionOrder)

Ordering options for commit contributions returned from the connection.

repository (Repository!)

The repository in which the commits were made.

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.


CommitEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Commit)

The item at the end of the edge.


CommitHistoryConnection

The connection type for Commit.

Fields

Name Description

edges ([CommitEdge])

A list of edges.

nodes ([Commit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ContentAttachment

A content attachment.

Fields

Name Description

body (String!)

The body text of the content attachment. This parameter supports markdown.

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

databaseId (Int!)

Identifies the primary key from the database.

title (String!)

The title of the content attachment.


ContentReference

A content reference.

Fields

Name Description

databaseId (Int!)

Identifies the primary key from the database.

reference (String!)

The reference of the content reference.


ContributionCalendar

A calendar of contributions made on GitHub by a user.

Fields

Name Description

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

totalContributions (Int!)

The count of total contributions in the calendar.

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.


ContributionCalendarDay

Represents a single day of contributions on GitHub by a user.

Fields

Name Description

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

contributionCount (Int!)

How many contributions were made by the user on this day.

date (Date!)

The day this square represents.

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.


ContributionCalendarMonth

A month of contributions in a user's contribution graph.

Fields

Name Description

firstDay (Date!)

The date of the first day of this month.

name (String!)

The name of the month.

totalWeeks (Int!)

How many weeks started in this month.

year (Int!)

The year the month occurred in.


ContributionCalendarWeek

A week of contributions in a user's contribution graph.

Fields

Name Description

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

firstDay (Date!)

The date of the earliest square in this week.


ContributionsCollection

A contributions collection aggregates contributions such as opened issues and commits created by a user.

Fields

Name Description

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

Arguments

maxRepositories (Int)

How many repositories should be included.

The default value is 25.

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

endedAt (DateTime!)

The ending date and time of this collection.

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was opened outside the collection's time range and ignoreTimeRange is false. If the issue is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

Arguments

ignoreTimeRange (Boolean)

If true, the first issue will be returned even if it was opened outside of the collection's time range.

Upcoming Change on 2019-07-01 UTC Description: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Reason: ignore_time_range will be removed.

The default value is false.

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that pull request was opened outside the collection's time range and ignoreTimeRange is not true. If the pull request is not visible but the user has opted to show private contributions, a RestrictedContribution will be returned.

Arguments

ignoreTimeRange (Boolean)

If true, the first pull request will be returned even if it was opened outside of the collection's time range.

Upcoming Change on 2019-07-01 UTC Description: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Reason: ignore_time_range will be removed.

The default value is false.

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that first repository was created outside the collection's time range and ignoreTimeRange is false. If the repository is not visible, then a RestrictedContribution is returned.

Arguments

ignoreTimeRange (Boolean)

If true, the first repository will be returned even if it was opened outside of the collection's time range.

Upcoming Change on 2019-07-01 UTC Description: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Reason: ignore_time_range will be removed.

The default value is false.

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details are not visible because they were made in a private repository. Can only be true if the user enabled private contribution counts.

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

excludeFirst (Boolean)

Should the user's first issue ever be excluded from the result.

The default value is false.

excludePopular (Boolean)

Should the user's most commented issue be excluded from the result.

The default value is false.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

Arguments

excludeFirst (Boolean)

Should the user's first issue ever be excluded from the result.

The default value is false.

excludePopular (Boolean)

Should the user's most commented issue be excluded from the result.

The default value is false.

maxRepositories (Int)

How many repositories should be included.

The default value is 25.

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date falls outside the collection's time range and ignoreTimeRange is false.

Arguments

ignoreTimeRange (Boolean)

If true, the contribution will be returned even if the user signed up outside of the collection's time range.

Upcoming Change on 2019-07-01 UTC Description: ignoreTimeRange will be removed. Use a ContributionsCollection starting sufficiently far back Reason: ignore_time_range will be removed.

The default value is false.

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time period. Can only be non-null when the user has enabled private contribution counts.

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this to get a different collection from an earlier time range that does have activity.

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one that does not have any contributions.

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified time frame.

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the specified time frame.

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

excludeFirst (Boolean)

Should the user's first pull request ever be excluded from the result.

The default value is false.

excludePopular (Boolean)

Should the user's most commented pull request be excluded from the result.

The default value is false.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

Arguments

excludeFirst (Boolean)

Should the user's first pull request ever be excluded from the result.

The default value is false.

excludePopular (Boolean)

Should the user's most commented pull request be excluded from the result.

The default value is false.

maxRepositories (Int)

How many repositories should be included.

The default value is 25.

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

Arguments

maxRepositories (Int)

How many repositories should be included.

The default value is 25.

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

excludeFirst (Boolean)

Should the user's first repository ever be excluded from the result.

The default value is false.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only non-zero when the user has chosen to share their private contribution counts.

startedAt (DateTime!)

The beginning date and time of this collection.

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

totalIssueContributions (Int!)

How many issues the user opened.

Arguments

excludeFirst (Boolean)

Should the user's first issue ever be excluded from this count.

The default value is false.

excludePopular (Boolean)

Should the user's most commented issue be excluded from this count.

The default value is false.

totalPullRequestContributions (Int!)

How many pull requests the user opened.

Arguments

excludeFirst (Boolean)

Should the user's first pull request ever be excluded from this count.

The default value is false.

excludePopular (Boolean)

Should the user's most commented pull request be excluded from this count.

The default value is false.

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

Arguments

excludeFirst (Boolean)

Should the user's first issue ever be excluded from this count.

The default value is false.

excludePopular (Boolean)

Should the user's most commented issue be excluded from this count.

The default value is false.

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

Arguments

excludeFirst (Boolean)

Should the user's first pull request ever be excluded from this count.

The default value is false.

excludePopular (Boolean)

Should the user's most commented pull request be excluded from this count.

The default value is false.

totalRepositoryContributions (Int!)

How many repositories the user created.

Arguments

excludeFirst (Boolean)

Should the user's first repository ever be excluded from this count.

The default value is false.

user (User!)

The user who made the contributions in this collection.


ConvertedNoteToIssueEvent

Represents aconverted_note_to_issueevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

project (Project)

Project referenced by event.

Preview notice

project is available under the Project event details preview. During the preview period, the API may change without notice.

projectCard (ProjectCard)

Project card referenced by this project event.

Preview notice

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

projectColumnName (String!)

Column name referenced by this project event.

Preview notice

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.


CreatedCommitContribution

Represents the contribution a user made by committing to a repository.

Fields

Name Description

commitCount (Int!)

How many commits were made on this day to this repository by the user.

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository the user made a commit in.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


CreatedCommitContributionConnection

The connection type for CreatedCommitContribution.

Fields

Name Description

edges ([CreatedCommitContributionEdge])

A list of edges.

nodes ([CreatedCommitContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.


CreatedCommitContributionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CreatedCommitContribution)

The item at the end of the edge.


CreatedIssueContribution

Represents the contribution a user made on GitHub by opening an issue.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

issue (Issue!)

The issue that was opened.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


CreatedIssueContributionConnection

The connection type for CreatedIssueContribution.

Fields

Name Description

edges ([CreatedIssueContributionEdge])

A list of edges.

nodes ([CreatedIssueContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CreatedIssueContributionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CreatedIssueContribution)

The item at the end of the edge.


CreatedPullRequestContribution

Represents the contribution a user made on GitHub by opening a pull request.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request that was opened.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


CreatedPullRequestContributionConnection

The connection type for CreatedPullRequestContribution.

Fields

Name Description

edges ([CreatedPullRequestContributionEdge])

A list of edges.

nodes ([CreatedPullRequestContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CreatedPullRequestContributionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestContribution)

The item at the end of the edge.


CreatedPullRequestReviewContribution

Represents the contribution a user made by leaving a review on a pull request.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

pullRequest (PullRequest!)

The pull request the user reviewed.

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

repository (Repository!)

The repository containing the pull request that the user reviewed.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


CreatedPullRequestReviewContributionConnection

The connection type for CreatedPullRequestReviewContribution.

Fields

Name Description

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CreatedPullRequestReviewContributionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.


CreatedRepositoryContribution

Represents the contribution a user made on GitHub by creating a repository.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

repository (Repository!)

The repository that was created.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


CreatedRepositoryContributionConnection

The connection type for CreatedRepositoryContribution.

Fields

Name Description

edges ([CreatedRepositoryContributionEdge])

A list of edges.

nodes ([CreatedRepositoryContribution])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


CreatedRepositoryContributionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (CreatedRepositoryContribution)

The item at the end of the edge.


CrossReferencedEvent

Represents a mention made by one issue or pull request to another.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

isCrossRepository (Boolean!)

Reference originated in a different repository.

referencedAt (DateTime!)

Identifies when the reference was made.

resourcePath (URI!)

The HTTP path for this pull request.

source (ReferencedSubject!)

Issue or pull request that made the reference.

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

url (URI!)

The HTTP URL for this pull request.

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.


DemilestonedEvent

Represents ademilestonedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

subject (MilestoneItem!)

Object referenced by event.


DeployKey

A repository deploy key.

Fields

Name Description

createdAt (DateTime!)

Identifies the date and time when the object was created.

key (String!)

The deploy key.

readOnly (Boolean!)

Whether or not the deploy key is read only.

title (String!)

The deploy key title.

verified (Boolean!)

Whether or not the deploy key has been verified.


DeployKeyConnection

The connection type for DeployKey.

Fields

Name Description

edges ([DeployKeyEdge])

A list of edges.

nodes ([DeployKey])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


DeployKeyEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (DeployKey)

The item at the end of the edge.


DeployedEvent

Represents adeployedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

deployment (Deployment!)

The deployment associated with thedeployedevent.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

The ref associated with thedeployedevent.


Deployment

Represents triggered deployment instance.

Fields

Name Description

commit (Commit)

Identifies the commit sha of the deployment.

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

Identifies the actor who triggered the deployment.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The deployment description.

environment (String)

The environment to which this deployment was made.

latestStatus (DeploymentStatus)

The latest status of this deployment.

payload (String)

Extra information that a deployment system might need.

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

repository (Repository!)

Identifies the repository associated with the deployment.

state (DeploymentState)

The current state of the deployment.

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

task (String)

The deployment task.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.


DeploymentConnection

The connection type for Deployment.

Fields

Name Description

edges ([DeploymentEdge])

A list of edges.

nodes ([Deployment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


DeploymentEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Deployment)

The item at the end of the edge.


DeploymentEnvironmentChangedEvent

Represents adeployment_environment_changedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

pullRequest (PullRequest!)

PullRequest referenced by event.


DeploymentStatus

Describes the status of a given deployment attempt.

Fields

Name Description

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

Identifies the actor who triggered the deployment.

deployment (Deployment!)

Identifies the deployment associated with status.

description (String)

Identifies the description of the deployment.

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

Preview notice

environment is available under the Deployments preview. During the preview period, the API may change without notice.

environmentUrl (URI)

Identifies the environment URL of the deployment.

logUrl (URI)

Identifies the log URL of the deployment.

state (DeploymentStatusState!)

Identifies the current state of the deployment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.


DeploymentStatusConnection

The connection type for DeploymentStatus.

Fields

Name Description

edges ([DeploymentStatusEdge])

A list of edges.

nodes ([DeploymentStatus])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


DeploymentStatusEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (DeploymentStatus)

The item at the end of the edge.


ExternalIdentity

An external identity provisioned by SAML SSO or SCIM.

Fields

Name Description

guid (String!)

The GUID for this identity.

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.


ExternalIdentityConnection

The connection type for ExternalIdentity.

Fields

Name Description

edges ([ExternalIdentityEdge])

A list of edges.

nodes ([ExternalIdentity])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ExternalIdentityEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ExternalIdentity)

The item at the end of the edge.


ExternalIdentitySamlAttributes

SAML attributes for the External Identity.

Fields

Name Description

nameId (String)

The NameID of the SAML identity.


ExternalIdentityScimAttributes

SCIM attributes for the External Identity.

Fields

Name Description

username (String)

The userName of the SCIM identity.


FollowerConnection

The connection type for User.

Fields

Name Description

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


FollowingConnection

The connection type for User.

Fields

Name Description

edges ([UserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


GenericHovercardContext

A generic hovercard context with a message and icon.

Preview notice

GenericHovercardContext is available under the Hovercards preview. During the preview period, the API may change without notice.

Fields

Name Description

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.


Gist

A Gist.

Fields

Name Description

comments (GistCommentConnection!)

A list of comments associated with the gist.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

The gist description.

files ([GistFile])

The files in this gist.

Arguments

limit (Int)

The maximum number of files to return.

The default value is 10.

oid (GitObjectID)

The oid of the files to return.

forks (GistConnection!)

A list of forks associated with the gist.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (GistOrder)

Ordering options for gists returned from the connection.

isFork (Boolean!)

Identifies if the gist is a fork.

isPublic (Boolean!)

Whether the gist is public or not.

name (String!)

The gist name.

owner (RepositoryOwner)

The gist owner.

pushedAt (DateTime)

Identifies when the gist was last pushed to.

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (StarOrder)

Order for connection.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.


GistComment

Represents a comment on an Gist.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

body (String!)

Identifies the comment body.

bodyHTML (HTML!)

The comment body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

gist (Gist!)

The associated gist.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized.

publishedAt (DateTime)

Identifies when the comment was published at.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


GistCommentConnection

The connection type for GistComment.

Fields

Name Description

edges ([GistCommentEdge])

A list of edges.

nodes ([GistComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


GistCommentEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (GistComment)

The item at the end of the edge.


GistConnection

The connection type for Gist.

Fields

Name Description

edges ([GistEdge])

A list of edges.

nodes ([Gist])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


GistEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Gist)

The item at the end of the edge.


GistFile

A file in a gist.

Fields

Name Description

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

encoding (String)

The gist file encoding.

extension (String)

The file extension from the file name.

isImage (Boolean!)

Indicates if this file is an image.

isTruncated (Boolean!)

Whether the file's contents were truncated.

language (Language)

The programming language this file is written in.

name (String)

The gist file name.

size (Int)

The gist file size in bytes.

text (String)

UTF8 text data or null if the file is binary.

Arguments

truncate (Int)

Optionally truncate the returned file to this length.


GitActor

Represents an actor in a Git commit (ie. an author or committer).

Fields

Name Description

avatarUrl (URI!)

A URL pointing to the author's public avatar.

Arguments

size (Int)

The size of the resulting square image.

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

email (String)

The email in the Git commit.

name (String)

The name in the Git commit.

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.


GitHubMetadata

Represents information about the GitHub instance.

Fields

Name Description

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.


GpgSignature

Represents a GPG signature on a Commit or Tag.

Fields

Name Description

email (String!)

Email used to sign this object.

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

keyId (String)

Hex-encoded ID of the key that signed this object.

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

signature (String!)

ASCII-armored signature header from object.

signer (User)

GitHub user corresponding to the email signing this commit.

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.


HeadRefDeletedEvent

Represents ahead_ref_deletedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

pullRequest (PullRequest!)

PullRequest referenced by event.


HeadRefForcePushedEvent

Represents ahead_ref_force_pushedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.


HeadRefRestoredEvent

Represents ahead_ref_restoredevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.


Hovercard

Detail needed to display a hovercard for a user.

Preview notice

Hovercard is available under the Hovercards preview. During the preview period, the API may change without notice.

Fields

Name Description

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.


Issue

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

Fields

Name Description

activeLockReason (LockReason)

Reason that the conversation was locked.

assignees (UserConnection!)

A list of Users assigned to this object.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

Identifies the body of the issue.

bodyHTML (HTML!)

Identifies the body of the issue rendered to HTML.

bodyText (String!)

Identifies the body of the issue rendered to text.

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

hovercard (Hovercard!)

The hovercard information for this issue.

Preview notice

hovercard is available under the Hovercards preview. During the preview period, the API may change without notice.

Arguments

includeNotificationContexts (Boolean)

Whether or not to include notification contexts.

The default value is true.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

labels (LabelConnection)

A list of labels associated with the object.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

lastEditedAt (DateTime)

The moment the editor made the last edit.

locked (Boolean!)

true if the object is locked.

milestone (Milestone)

Identifies the milestone associated with the issue.

number (Int!)

Identifies the issue number.

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

archivedStates ([ProjectCardArchivedState])

A list of archived states to filter the cards by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path for this issue.

state (IssueState!)

Identifies the state of the issue.

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

Deprecation notice

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2019-10-01 UTC.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

since (DateTime)

Allows filtering timeline events by a since timestamp.

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

itemTypes ([IssueTimelineItemsItemType!])

Filter timeline items by type.

last (Int)

Returns the last n elements from the list.

since (DateTime)

Filter timeline items by a since timestamp.

skip (Int)

Skips the first n elements in the list.

title (String!)

Identifies the issue title.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this issue.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.


IssueComment

Represents a comment on an Issue.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

issue (Issue!)

Identifies the issue associated with the comment.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized.

publishedAt (DateTime)

Identifies when the comment was published at.

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a pull request.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path for this issue comment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this issue comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


IssueCommentConnection

The connection type for IssueComment.

Fields

Name Description

edges ([IssueCommentEdge])

A list of edges.

nodes ([IssueComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


IssueCommentEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (IssueComment)

The item at the end of the edge.


IssueConnection

The connection type for Issue.

Fields

Name Description

edges ([IssueEdge])

A list of edges.

nodes ([Issue])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


IssueContributionsByRepository

This aggregates issues opened by a user within one repository.

Fields

Name Description

contributions (CreatedIssueContributionConnection!)

The issue contributions.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

repository (Repository!)

The repository in which the issues were opened.


IssueEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Issue)

The item at the end of the edge.


IssueTimelineConnection

The connection type for IssueTimelineItem.

Fields

Name Description

edges ([IssueTimelineItemEdge])

A list of edges.

nodes ([IssueTimelineItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


IssueTimelineItemEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (IssueTimelineItem)

The item at the end of the edge.


IssueTimelineItemsConnection

The connection type for IssueTimelineItems.

Fields

Name Description

edges ([IssueTimelineItemsEdge])

A list of edges.

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

nodes ([IssueTimelineItems])

A list of nodes.

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.


IssueTimelineItemsEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (IssueTimelineItems)

The item at the end of the edge.


JoinedGitHubContribution

Represents a user signing up for a GitHub account.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


Label

A label for categorizing Issues or Milestones with a given Repository.

Fields

Name Description

color (String!)

Identifies the label color.

createdAt (DateTime)

Identifies the date and time when the label was created.

description (String)

A brief description of this label.

isDefault (Boolean!)

Indicates whether or not this is a default label.

issues (IssueConnection!)

A list of issues associated with this label.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

filterBy (IssueFilters)

Filtering options for issues returned from the connection.

first (Int)

Returns the first n elements from the list.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for issues returned from the connection.

states ([IssueState!])

A list of states to filter the issues by.

name (String!)

Identifies the label name.

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

baseRefName (String)

The base ref name to filter the pull requests by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

headRefName (String)

The head ref name to filter the pull requests by.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for pull requests returned from the connection.

states ([PullRequestState!])

A list of states to filter the pull requests by.

repository (Repository!)

The repository associated with this label.

resourcePath (URI!)

The HTTP path for this label.

updatedAt (DateTime)

Identifies the date and time when the label was last updated.

url (URI!)

The HTTP URL for this label.


LabelConnection

The connection type for Label.

Fields

Name Description

edges ([LabelEdge])

A list of edges.

nodes ([Label])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


LabelEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Label)

The item at the end of the edge.


LabeledEvent

Represents alabeledevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

label (Label!)

Identifies the label associated with thelabeledevent.

labelable (Labelable!)

Identifies the Labelable associated with the event.


Language

Represents a given language found in repositories.

Fields

Name Description

color (String)

The color defined for the current language.

name (String!)

The name of the current language.


LanguageConnection

A list of languages associated with the parent.

Fields

Name Description

edges ([LanguageEdge])

A list of edges.

nodes ([Language])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

totalSize (Int!)

The total size in bytes of files written in that language.


LanguageEdge

Represents the language of a repository.

Fields

Name Description

size (Int!)

The number of bytes of code written in the language.


License

A repository's open source license.

Fields

Name Description

body (String!)

The full text of the license.

conditions ([LicenseRule]!)

The conditions set by the license.

description (String)

A human-readable description of the license.

featured (Boolean!)

Whether the license should be featured.

hidden (Boolean!)

Whether the license should be displayed in license pickers.

implementation (String)

Instructions on how to implement the license.

key (String!)

The lowercased SPDX ID of the license.

limitations ([LicenseRule]!)

The limitations set by the license.

name (String!)

The license full name specified by https://spdx.org/licenses.

nickname (String)

Customary short name if applicable (e.g, GPLv3).

permissions ([LicenseRule]!)

The permissions set by the license.

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

url (URI)

URL to the license on https://choosealicense.com.


LicenseRule

Describes a License's conditions, permissions, and limitations.

Fields

Name Description

description (String!)

A description of the rule.

key (String!)

The machine-readable rule key.

label (String!)

The human-readable rule label.


LockedEvent

Represents alockedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

lockReason (LockReason)

Reason that the conversation was locked (optional).

lockable (Lockable!)

Object that was locked.


Mannequin

A placeholder user for attribution of imported data on GitHub.

Fields

Name Description

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

Arguments

size (Int)

The size of the resulting square image.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

login (String!)

The username of the actor.

resourcePath (URI!)

The HTML path to this resource.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The URL to this resource.


MembersCanDeleteReposClearAuditEntry

Audit log entry for a members_can_delete_repos.clear event.

Preview notice

MembersCanDeleteReposClearAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


MembersCanDeleteReposDisableAuditEntry

Audit log entry for a members_can_delete_repos.disable event.

Preview notice

MembersCanDeleteReposDisableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


MembersCanDeleteReposEnableAuditEntry

Audit log entry for a members_can_delete_repos.enable event.

Preview notice

MembersCanDeleteReposEnableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


MentionedEvent

Represents amentionedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.


MergedEvent

Represents amergedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

commit (Commit)

Identifies the commit associated with the merge event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

mergeRef (Ref)

Identifies the Ref associated with the merge event.

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this merged event.

url (URI!)

The HTTP URL for this merged event.


Milestone

Represents a Milestone object on a given repository.

Fields

Name Description

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

Identifies the actor who created the milestone.

description (String)

Identifies the description of the milestone.

dueOn (DateTime)

Identifies the due date of the milestone.

issuePrioritiesDebug (String!)

Just for debugging on review-lab.

issues (IssueConnection!)

A list of issues associated with the milestone.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

filterBy (IssueFilters)

Filtering options for issues returned from the connection.

first (Int)

Returns the first n elements from the list.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for issues returned from the connection.

states ([IssueState!])

A list of states to filter the issues by.

number (Int!)

Identifies the number of the milestone.

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

baseRefName (String)

The base ref name to filter the pull requests by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

headRefName (String)

The head ref name to filter the pull requests by.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for pull requests returned from the connection.

states ([PullRequestState!])

A list of states to filter the pull requests by.

repository (Repository!)

The repository associated with this milestone.

resourcePath (URI!)

The HTTP path for this milestone.

state (MilestoneState!)

Identifies the state of the milestone.

title (String!)

Identifies the title of the milestone.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this milestone.


MilestoneConnection

The connection type for Milestone.

Fields

Name Description

edges ([MilestoneEdge])

A list of edges.

nodes ([Milestone])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


MilestoneEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Milestone)

The item at the end of the edge.


MilestonedEvent

Represents amilestonedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

subject (MilestoneItem!)

Object referenced by event.


MovedColumnsInProjectEvent

Represents amoved_columns_in_projectevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

Preview notice

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

project (Project)

Project referenced by event.

Preview notice

project is available under the Project event details preview. During the preview period, the API may change without notice.

projectCard (ProjectCard)

Project card referenced by this project event.

Preview notice

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

projectColumnName (String!)

Column name the issue or pull request was moved to.

Preview notice

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.


OauthApplicationCreateAuditEntry

Audit log entry for a oauth_application.create event.

Preview notice

OauthApplicationCreateAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

applicationUrl (URI)

The application URL of the OAuth Application.

callbackUrl (URI)

The callback URL of the OAuth Application.

createdAt (PreciseDateTime!)

The time the action was initiated.

oauthApplicationName (String)

The name of the OAuth Application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

rateLimit (Int)

The rate limit of the OAuth Application.

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgAddBillingManagerAuditEntry

Audit log entry for a org.add_billing_manager.

Preview notice

OrgAddBillingManagerAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

invitationEmail (String)

The email address used to invite a billing manager for the organization.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgAddMemberAuditEntry

Audit log entry for a org.add_member.

Preview notice

OrgAddMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgBlockUserAuditEntry

Audit log entry for a org.block_user.

Preview notice

OrgBlockUserAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

blockedUser (User)

The blocked user.

blockedUserName (String)

The username of the blocked user.

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

blockedUserUrl (URI)

The HTTP URL for the blocked user.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgConfigDisableCollaboratorsOnlyAuditEntry

Audit log entry for a org.config.disable_collaborators_only event.

Preview notice

OrgConfigDisableCollaboratorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgConfigEnableCollaboratorsOnlyAuditEntry

Audit log entry for a org.config.enable_collaborators_only event.

Preview notice

OrgConfigEnableCollaboratorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgDisableOauthAppRestrictionsAuditEntry

Audit log entry for a org.disable_oauth_app_restrictions event.

Preview notice

OrgDisableOauthAppRestrictionsAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgDisableSamlAuditEntry

Audit log entry for a org.disable_saml event.

Preview notice

OrgDisableSamlAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

issuerUrl (URI)

The SAML provider's issuer URL.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgDisableTwoFactorRequirementAuditEntry

Audit log entry for a org.disable_two_factor_requirement event.

Preview notice

OrgDisableTwoFactorRequirementAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgEnableOauthAppRestrictionsAuditEntry

Audit log entry for a org.enable_oauth_app_restrictions event.

Preview notice

OrgEnableOauthAppRestrictionsAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgEnableSamlAuditEntry

Audit log entry for a org.enable_saml event.

Preview notice

OrgEnableSamlAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

issuerUrl (URI)

The SAML provider's issuer URL.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgEnableTwoFactorRequirementAuditEntry

Audit log entry for a org.enable_two_factor_requirement event.

Preview notice

OrgEnableTwoFactorRequirementAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgInviteMemberAuditEntry

Audit log entry for a org.invite_member event.

Preview notice

OrgInviteMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

email (String)

The email address of the organization invitation.

organization (Organization)

The Organization associated with the Audit Entry.

organizationInvitation (OrganizationInvitation)

The organization invitation.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgInviteToBusinessAuditEntry

Audit log entry for a org.invite_to_business event.

Preview notice

OrgInviteToBusinessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgOauthAppAccessApprovedAuditEntry

Audit log entry for a org.oauth_app_access_approved event.

Preview notice

OrgOauthAppAccessApprovedAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

oauthApplicationName (String)

The name of the OAuth Application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgOauthAppAccessDeniedAuditEntry

Audit log entry for a org.oauth_app_access_denied event.

Preview notice

OrgOauthAppAccessDeniedAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

oauthApplicationName (String)

The name of the OAuth Application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgOauthAppAccessRequestedAuditEntry

Audit log entry for a org.oauth_app_access_requested event.

Preview notice

OrgOauthAppAccessRequestedAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

oauthApplicationName (String)

The name of the OAuth Application.

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgRemoveBillingManagerAuditEntry

Audit log entry for a org.remove_billing_manager event.

Preview notice

OrgRemoveBillingManagerAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgRemoveMemberAuditEntry

Audit log entry for a org.remove_member event.

Preview notice

OrgRemoveMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgRemoveOutsideCollaboratorAuditEntry

Audit log entry for a org.remove_outside_collaborator event.

Preview notice

OrgRemoveOutsideCollaboratorAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgRestoreMemberAuditEntry

Audit log entry for a org.restore_member event.

Preview notice

OrgRestoreMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

restoredIssueAssignmentsCount (Int)

The number of issue assignemnts for the restored member.

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

restoredMembershipsCount (Int)

The number of restored memberships.

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgRestoreMemberMembershipOrganizationAuditEntryData

Metadata for an organization membership for org.restore_member actions.

Preview notice

OrgRestoreMemberMembershipOrganizationAuditEntryData is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.


OrgRestoreMemberMembershipRepositoryAuditEntryData

Metadata for a repository membership for org.restore_member actions.

Preview notice

OrgRestoreMemberMembershipRepositoryAuditEntryData is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.


OrgRestoreMemberMembershipTeamAuditEntryData

Metadata for a team membership for org.restore_member actions.

Preview notice

OrgRestoreMemberMembershipTeamAuditEntryData is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

team (Team)

The team associated with the action.

teamName (String)

The name of the team.

teamResourcePath (URI)

The HTTP path for this team.

teamUrl (URI)

The HTTP URL for this team.


OrgUnblockUserAuditEntry

Audit log entry for a org.unblock_user.

Preview notice

OrgUnblockUserAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

blockedUser (User)

The user being unblocked by the organization.

blockedUserName (String)

The username of the blocked user.

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

blockedUserUrl (URI)

The HTTP URL for the blocked user.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgUpdateDefaultRepositoryPermissionAuditEntry

Audit log entry for a org.update_default_repository_permission.

Preview notice

OrgUpdateDefaultRepositoryPermissionAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgUpdateMemberAuditEntry

Audit log entry for a org.update_member event.

Preview notice

OrgUpdateMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


OrgUpdateMemberRepositoryCreationPermissionAuditEntry

Audit log entry for a org.update_member_repository_creation_permission event.

Preview notice

OrgUpdateMemberRepositoryCreationPermissionAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

canCreateRepositories (Boolean)

Can members create repositories in the organization.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.


OrgUpdateMemberRepositoryInvitationPermissionAuditEntry

Audit log entry for a org.update_member_repository_invitation_permission event.

Preview notice

OrgUpdateMemberRepositoryInvitationPermissionAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


Organization

An account on GitHub, with one or more owners, that has repositories, members and teams.

Fields

Name Description

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

Arguments

type (PinnableItemType)

Filter to only a particular kind of pinnable item.

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

Preview notice

auditLog is available under the Audit log preview. During the preview period, the API may change without notice.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (AuditLogOrder)

Ordering options for the returned audit log entries.

query (String)

The query string to filter audit entries.

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

Arguments

size (Int)

The size of the resulting square image.

databaseId (Int)

Identifies the primary key from the database.

description (String)

The organization's public profile description.

email (String)

The organization's public email.

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

location (String)

The organization's public profile location.

login (String!)

The organization's login name.

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (UserStatusOrder)

Ordering options for user statuses returned from the connection.

members (UserConnection!)

A list of users who are members of this organization.

Deprecation notice

members is deprecated.

The members field is deprecated and will be removed soon. Use Organization.membersWithRole instead. Removal on 2019-04-01 UTC.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

name (String)

The organization's public profile name.

newTeamResourcePath (URI!)

The HTTP path creating a new team.

newTeamUrl (URI!)

The HTTP URL creating a new team.

organizationBillingEmail (String)

The billing email for the organization.

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

types ([PinnableItemType!])

Filter the types of pinnable items that are returned.

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

types ([PinnableItemType!])

Filter the types of pinned items that are returned.

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

pinnedRepositories (RepositoryConnection!)

A list of repositories this user has pinned to their profile.

Deprecation notice

pinnedRepositories is deprecated.

pinnedRepositories will be removed Use ProfileOwner.pinnedItems instead. Removal on 2019-10-01 UTC.

Arguments

affiliations ([RepositoryAffiliation])

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isLocked (Boolean)

If non-null, filters repositories according to whether they have been locked.

last (Int)

Returns the last n elements from the list.

orderBy (RepositoryOrder)

Ordering options for repositories returned from the connection.

ownerAffiliations ([RepositoryAffiliation])

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy (RepositoryPrivacy)

If non-null, filters repositories according to privacy.

project (Project)

Find project by number.

Arguments

number (Int!)

The project number to find.

projects (ProjectConnection!)

A list of projects under the owner.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ProjectOrder)

Ordering options for projects returned from the connection.

search (String)

Query to search projects by, currently only searching by name.

states ([ProjectState!])

A list of states to filter the projects by.

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

projectsUrl (URI!)

The HTTP URL listing organization's projects.

repositories (RepositoryConnection!)

A list of repositories that the user owns.

Arguments

affiliations ([RepositoryAffiliation])

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isFork (Boolean)

If non-null, filters repositories according to whether they are forks of another repository.

isLocked (Boolean)

If non-null, filters repositories according to whether they have been locked.

last (Int)

Returns the last n elements from the list.

orderBy (RepositoryOrder)

Ordering options for repositories returned from the connection.

ownerAffiliations ([RepositoryAffiliation])

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy (RepositoryPrivacy)

If non-null, filters repositories according to privacy.

repository (Repository)

Find Repository.

Arguments

name (String!)

Name of Repository to find.

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

resourcePath (URI!)

The HTTP path for this organization.

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

team (Team)

Find an organization's team by its slug.

Arguments

slug (String!)

The name or slug of the team to find.

teams (TeamConnection!)

A list of teams in this organization.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

ldapMapped (Boolean)

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

orderBy (TeamOrder)

Ordering options for teams returned from the connection.

privacy (TeamPrivacy)

If non-null, filters teams according to privacy.

query (String)

If non-null, filters teams with query on team name and team slug.

role (TeamRole)

If non-null, filters teams according to whether the viewer is an admin or member on team.

rootTeamsOnly (Boolean)

If true, restrict to only root teams.

The default value is false.

userLogins ([String!])

User logins to filter by.

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

teamsUrl (URI!)

The HTTP URL listing organization's teams.

url (URI!)

The HTTP URL for this organization.

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

websiteUrl (URI)

The organization's public profile URL.


OrganizationAuditEntryConnection

The connection type for OrganizationAuditEntry.

Fields

Name Description

edges ([OrganizationAuditEntryEdge])

A list of edges.

nodes ([OrganizationAuditEntry])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


OrganizationAuditEntryEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (OrganizationAuditEntry)

The item at the end of the edge.


OrganizationConnection

The connection type for Organization.

Fields

Name Description

edges ([OrganizationEdge])

A list of edges.

nodes ([Organization])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


OrganizationEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Organization)

The item at the end of the edge.


OrganizationIdentityProvider

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

Fields

Name Description

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provder to sign assertions and responses.

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

organization (Organization)

Organization this Identity Provider belongs to.

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.


OrganizationInvitation

An Invitation for a user to an organization.

Fields

Name Description

createdAt (DateTime!)

Identifies the date and time when the object was created.

email (String)

The email address of the user invited to the organization.

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

invitee (User)

The user who was invited to the organization.

inviter (User!)

The user who created the invitation.

organization (Organization!)

The organization the invite is for.

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).


OrganizationInvitationConnection

The connection type for OrganizationInvitation.

Fields

Name Description

edges ([OrganizationInvitationEdge])

A list of edges.

nodes ([OrganizationInvitation])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


OrganizationInvitationEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (OrganizationInvitation)

The item at the end of the edge.


OrganizationMemberConnection

The connection type for User.

Fields

Name Description

edges ([OrganizationMemberEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


OrganizationMemberEdge

Represents a user within an organization.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

node (User)

The item at the end of the edge.

role (OrganizationMemberRole)

The role this user has in the organization.


OrganizationTeamsHovercardContext

An organization teams hovercard context.

Preview notice

OrganizationTeamsHovercardContext is available under the Hovercards preview. During the preview period, the API may change without notice.

Fields

Name Description

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

teamsResourcePath (URI!)

The path for the full team list for this user.

teamsUrl (URI!)

The URL for the full team list for this user.

totalTeamCount (Int!)

The total number of teams the user is on in the organization.


OrganizationsHovercardContext

An organization list hovercard context.

Preview notice

OrganizationsHovercardContext is available under the Hovercards preview. During the preview period, the API may change without notice.

Fields

Name Description

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

totalOrganizationCount (Int!)

The total number of organizations this user is in.


PageInfo

Information about pagination in a connection.

Fields

Name Description

endCursor (String)

When paginating forwards, the cursor to continue.

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

startCursor (String)

When paginating backwards, the cursor to continue.


PermissionSource

A level of permission and source for a user's access to a repository.

Fields

Name Description

organization (Organization!)

The organization the repository belongs to.

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

source (PermissionGranter!)

The source of this permission.


PinnableItemConnection

The connection type for PinnableItem.

Fields

Name Description

edges ([PinnableItemEdge])

A list of edges.

nodes ([PinnableItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PinnableItemEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PinnableItem)

The item at the end of the edge.


PinnedEvent

Represents apinnedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

issue (Issue!)

Identifies the issue associated with the event.


PinnedIssue

A Pinned Issue is a issue pinned to a repository's index page.

Preview notice

PinnedIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

Fields

Name Description

databaseId (Int)

Identifies the primary key from the database.

issue (Issue!)

The issue that was pinned.

pinnedBy (Actor!)

The actor that pinned this issue.

repository (Repository!)

The repository that this issue was pinned to.


PinnedIssueConnection

The connection type for PinnedIssue.

Preview notice

PinnedIssueConnection is available under the Pinned issues preview. During the preview period, the API may change without notice.

Fields

Name Description

edges ([PinnedIssueEdge])

A list of edges.

nodes ([PinnedIssue])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PinnedIssueEdge

An edge in a connection.

Preview notice

PinnedIssueEdge is available under the Pinned issues preview. During the preview period, the API may change without notice.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PinnedIssue)

The item at the end of the edge.


PrivateRepositoryForkingDisableAuditEntry

Audit log entry for a private_repository_forking.disable event.

Preview notice

PrivateRepositoryForkingDisableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


PrivateRepositoryForkingEnableAuditEntry

Audit log entry for a private_repository_forking.enable event.

Preview notice

PrivateRepositoryForkingEnableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


ProfileItemShowcase

A curatable list of repositories relating to a repository owner, which defaults to showing the most popular repositories they own.

Fields

Name Description

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any pinned items, those will be returned. Otherwise, the profile owner's popular repositories will be returned.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.


Project

Projects manage issues, pull requests and notes within a project owner.

Fields

Name Description

body (String)

The project's description body.

bodyHTML (HTML!)

The projects description body rendered to HTML.

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

closedAt (DateTime)

Identifies the date and time when the object was closed.

columns (ProjectColumnConnection!)

List of columns in the project.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who originally created the project.

databaseId (Int)

Identifies the primary key from the database.

name (String!)

The project's name.

number (Int!)

The project's number.

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

archivedStates ([ProjectCardArchivedState])

A list of archived states to filter the cards by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

resourcePath (URI!)

The HTTP path for this project.

state (ProjectState!)

Whether the project is open or closed.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this project.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.


ProjectCard

A card in a project.

Fields

Name Description

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one project column at a time. The column field will be null if the card is created in a pending state and has yet to be associated with a column. Once cards are associated with a column, they will not become pending in the future.

content (ProjectCardItem)

The card content item.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this card.

databaseId (Int)

Identifies the primary key from the database.

isArchived (Boolean!)

Whether the card is archived.

note (String)

The card note.

project (Project!)

The project that contains this card.

resourcePath (URI!)

The HTTP path for this card.

state (ProjectCardState)

The state of ProjectCard.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this card.


ProjectCardConnection

The connection type for ProjectCard.

Fields

Name Description

edges ([ProjectCardEdge])

A list of edges.

nodes ([ProjectCard])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ProjectCardEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ProjectCard)

The item at the end of the edge.


ProjectColumn

A column inside a project.

Fields

Name Description

cards (ProjectCardConnection!)

List of cards in the column.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

archivedStates ([ProjectCardArchivedState])

A list of archived states to filter the cards by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

name (String!)

The project column's name.

project (Project!)

The project that contains this column.

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

resourcePath (URI!)

The HTTP path for this project column.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this project column.


ProjectColumnConnection

The connection type for ProjectColumn.

Fields

Name Description

edges ([ProjectColumnEdge])

A list of edges.

nodes ([ProjectColumn])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ProjectColumnEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ProjectColumn)

The item at the end of the edge.


ProjectConnection

A list of projects associated with the owner.

Fields

Name Description

edges ([ProjectEdge])

A list of edges.

nodes ([Project])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ProjectEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Project)

The item at the end of the edge.


PublicKey

A user's public key.

Fields

Name Description

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before March 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

fingerprint (String!)

The fingerprint for this PublicKey.

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

key (String!)

The public key string.

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before March 5th, 2014 may have inaccurate values. Values will be null for keys not owned by the user.


PublicKeyConnection

The connection type for PublicKey.

Fields

Name Description

edges ([PublicKeyEdge])

A list of edges.

nodes ([PublicKey])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PublicKeyEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PublicKey)

The item at the end of the edge.


PullRequest

A repository pull request.

Fields

Name Description

activeLockReason (LockReason)

Reason that the conversation was locked.

additions (Int!)

The number of additions in this pull request.

assignees (UserConnection!)

A list of Users assigned to this object.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

baseRef (Ref)

Identifies the base Ref associated with the pull request.

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

baseRepository (Repository)

The repository associated with this pull request's base Ref.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The body rendered to HTML.

bodyText (String!)

The body rendered to text.

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

Preview notice

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

changedFiles (Int!)

The number of changed files in this pull request.

closed (Boolean!)

true if the pull request is closed.

closedAt (DateTime)

Identifies the date and time when the object was closed.

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

deletions (Int!)

The number of deletions in this pull request.

editor (Actor)

The actor who edited this pull request's body.

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

headRef (Ref)

Identifies the head Ref associated with the pull request.

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

headRepository (Repository)

The repository associated with this pull request's head Ref.

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

hovercard (Hovercard!)

The hovercard information for this issue.

Preview notice

hovercard is available under the Hovercards preview. During the preview period, the API may change without notice.

Arguments

includeNotificationContexts (Boolean)

Whether or not to include notification contexts.

The default value is true.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isCrossRepository (Boolean!)

The head and base repositories are different.

isDraft (Boolean!)

Identifies if the pull request is a draft.

Preview notice

isDraft is available under the Draft pull requests preview. During the preview period, the API may change without notice.

labels (LabelConnection)

A list of labels associated with the object.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

lastEditedAt (DateTime)

The moment the editor made the last edit.

locked (Boolean!)

true if the pull request is locked.

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

mergeCommit (Commit)

The commit that was created when this pull request was merged.

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

Preview notice

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

merged (Boolean!)

Whether or not the pull request was merged.

mergedAt (DateTime)

The date and time that the pull request was merged.

mergedBy (Actor)

The actor who merged the pull request.

milestone (Milestone)

Identifies the milestone associated with the pull request.

number (Int!)

Identifies the pull request number.

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

permalink (URI!)

The permalink to the pull request.

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request could be merged. This field will not return a value if the pull request is merged, or if the test merge commit is still being generated. See the mergeable field for more details on the mergeability of the pull request.

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

archivedStates ([ProjectCardArchivedState])

A list of archived states to filter the cards by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path for this pull request.

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

revertUrl (URI!)

The HTTP URL for reverting this pull request.

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

author (String)

Filter by author of the review.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

states ([PullRequestReviewState!])

A list of states to filter the reviews.

state (PullRequestState!)

Identifies the state of the pull request.

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

Deprecation notice

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2019-10-01 UTC.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

since (DateTime)

Allows filtering timeline events by a since timestamp.

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

itemTypes ([PullRequestTimelineItemsItemType!])

Filter timeline items by type.

last (Int)

Returns the last n elements from the list.

since (DateTime)

Filter timeline items by a since timestamp.

skip (Int)

Skips the first n elements in the list.

title (String!)

Identifies the pull request title.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this pull request.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.


PullRequestChangedFile

A file changed in a pull request.

Fields

Name Description

additions (Int!)

The number of additions to the file.

deletions (Int!)

The number of deletions to the file.

path (String!)

The path of the file.


PullRequestChangedFileConnection

The connection type for PullRequestChangedFile.

Fields

Name Description

edges ([PullRequestChangedFileEdge])

A list of edges.

nodes ([PullRequestChangedFile])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestChangedFileEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestChangedFile)

The item at the end of the edge.


PullRequestCommit

Represents a Git commit part of a pull request.

Fields

Name Description

commit (Commit!)

The Git commit object.

pullRequest (PullRequest!)

The pull request this commit belongs to.

resourcePath (URI!)

The HTTP path for this pull request commit.

url (URI!)

The HTTP URL for this pull request commit.


PullRequestCommitCommentThread

Represents a commit comment thread part of a pull request.

Fields

Name Description

comments (CommitCommentConnection!)

The comments that exist in this thread.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commit (Commit!)

The commit the comments were made on.

path (String)

The file the comments were made on.

position (Int)

The position in the diff for the commit that the comment was made on.

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

repository (Repository!)

The repository associated with this node.


PullRequestCommitConnection

The connection type for PullRequestCommit.

Fields

Name Description

edges ([PullRequestCommitEdge])

A list of edges.

nodes ([PullRequestCommit])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestCommitEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestCommit)

The item at the end of the edge.


PullRequestConnection

The connection type for PullRequest.

Fields

Name Description

edges ([PullRequestEdge])

A list of edges.

nodes ([PullRequest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestContributionsByRepository

This aggregates pull requests opened by a user within one repository.

Fields

Name Description

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

repository (Repository!)

The repository in which the pull requests were opened.


PullRequestEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequest)

The item at the end of the edge.


PullRequestReview

A review object for a given pull request.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

Identifies the pull request review body.

bodyHTML (HTML!)

The body of this review rendered to HTML.

bodyText (String!)

The body of this review rendered as plain text.

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commit (Commit)

Identifies the commit associated with this pull request review.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

lastEditedAt (DateTime)

The moment the editor made the last edit.

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

publishedAt (DateTime)

Identifies when the comment was published at.

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL permalink for this PullRequestReview.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


PullRequestReviewComment

A review comment associated with a given repository pull request.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

body (String!)

The comment body of this review comment.

bodyHTML (HTML!)

The comment body of this review comment rendered to HTML.

bodyText (String!)

The comment body of this review comment rendered as plain text.

commit (Commit!)

Identifies the commit associated with the comment.

createdAt (DateTime!)

Identifies when the comment was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

diffHunk (String!)

The diff hunk to which the comment applies.

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

lastEditedAt (DateTime)

The moment the editor made the last edit.

minimizedReason (String)

Returns why the comment was minimized.

originalCommit (Commit)

Identifies the original commit associated with the comment.

originalPosition (Int!)

The original line index in the diff to which the comment applies.

outdated (Boolean!)

Identifies when the comment body is outdated.

path (String!)

The path to which the comment applies.

position (Int)

The line index in the diff to which the comment applies.

publishedAt (DateTime)

Identifies when the comment was published at.

pullRequest (PullRequest!)

The pull request associated with this review comment.

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

replyTo (PullRequestReviewComment)

The comment this is a reply to.

repository (Repository!)

The repository associated with this node.

resourcePath (URI!)

The HTTP path permalink for this review comment.

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

updatedAt (DateTime!)

Identifies when the comment was last updated.

url (URI!)

The HTTP URL permalink for this review comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.


PullRequestReviewCommentConnection

The connection type for PullRequestReviewComment.

Fields

Name Description

edges ([PullRequestReviewCommentEdge])

A list of edges.

nodes ([PullRequestReviewComment])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestReviewCommentEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestReviewComment)

The item at the end of the edge.


PullRequestReviewConnection

The connection type for PullRequestReview.

Fields

Name Description

edges ([PullRequestReviewEdge])

A list of edges.

nodes ([PullRequestReview])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestReviewContributionsByRepository

This aggregates pull request reviews made by a user within one repository.

Fields

Name Description

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ContributionOrder)

Ordering options for contributions returned from the connection.

repository (Repository!)

The repository in which the pull request reviews were made.


PullRequestReviewEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestReview)

The item at the end of the edge.


PullRequestReviewThread

A threaded list of comments for a given pull request.

Fields

Name Description

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

isResolved (Boolean!)

Whether this thread has been resolved.

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

repository (Repository!)

Identifies the repository associated with this thread.

resolvedBy (User)

The user who resolved this thread.

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.


PullRequestReviewThreadConnection

Review comment threads for a pull request review.

Fields

Name Description

edges ([PullRequestReviewThreadEdge])

A list of edges.

nodes ([PullRequestReviewThread])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestReviewThreadEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestReviewThread)

The item at the end of the edge.


PullRequestRevisionMarker

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

Fields

Name Description

createdAt (DateTime!)

Identifies the date and time when the object was created.

lastSeenCommit (Commit!)

The last commit the viewer has seen.

pullRequest (PullRequest!)

The pull request to which the marker belongs.


PullRequestTimelineConnection

The connection type for PullRequestTimelineItem.

Fields

Name Description

edges ([PullRequestTimelineItemEdge])

A list of edges.

nodes ([PullRequestTimelineItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PullRequestTimelineItemEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestTimelineItem)

The item at the end of the edge.


PullRequestTimelineItemsConnection

The connection type for PullRequestTimelineItems.

Fields

Name Description

edges ([PullRequestTimelineItemsEdge])

A list of edges.

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

nodes ([PullRequestTimelineItems])

A list of nodes.

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.


PullRequestTimelineItemsEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PullRequestTimelineItems)

The item at the end of the edge.


Push

A Git push.

Preview notice

Push is available under the Checks preview. During the preview period, the API may change without notice.

Fields

Name Description

nextSha (GitObjectID)

The SHA after the push.

permalink (URI!)

The permalink for this push.

previousSha (GitObjectID)

The SHA before the push.

pusher (User!)

The user who pushed.

repository (Repository!)

The repository that was pushed to.


PushAllowance

A team or user who has the ability to push to a protected branch.

Fields

Name Description

actor (PushAllowanceActor)

The actor that can push.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.


PushAllowanceConnection

The connection type for PushAllowance.

Fields

Name Description

edges ([PushAllowanceEdge])

A list of edges.

nodes ([PushAllowance])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


PushAllowanceEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (PushAllowance)

The item at the end of the edge.


RateLimit

Represents the client's rate limit.

Fields

Name Description

cost (Int!)

The point cost for the current query counting against the rate limit.

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

nodeCount (Int!)

The maximum number of nodes this query may return.

remaining (Int!)

The number of points remaining in the current rate limit window.

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.


ReactingUserConnection

The connection type for User.

Fields

Name Description

edges ([ReactingUserEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ReactingUserEdge

Represents a user that's made a reaction.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

reactedAt (DateTime!)

The moment when the user made the reaction.


Reaction

An emoji reaction to a particular piece of content.

Fields

Name Description

content (ReactionContent!)

Identifies the emoji reaction.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

reactable (Reactable!)

The reactable piece of content.

user (User)

Identifies the user who created this reaction.


ReactionConnection

A list of reactions that have been left on the subject.

Fields

Name Description

edges ([ReactionEdge])

A list of edges.

nodes ([Reaction])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.


ReactionEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Reaction)

The item at the end of the edge.


ReactionGroup

A group of emoji reactions to a particular piece of content.

Fields

Name Description

content (ReactionContent!)

Identifies the emoji reaction.

createdAt (DateTime)

Identifies when the reaction was created.

subject (Reactable!)

The subject that was reacted to.

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.


ReadyForReviewEvent

Represents aready_for_reviewevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.

resourcePath (URI!)

The HTTP path for this ready for review event.

url (URI!)

The HTTP URL for this ready for review event.


Ref

Represents a Git reference.

Fields

Name Description

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

baseRefName (String)

The base ref name to filter the pull requests by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

headRefName (String)

The head ref name to filter the pull requests by.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for pull requests returned from the connection.

states ([PullRequestState!])

A list of states to filter the pull requests by.

name (String!)

The ref name.

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

repository (Repository!)

The repository the ref belongs to.

target (GitObject!)

The object the ref points to.


RefConnection

The connection type for Ref.

Fields

Name Description

edges ([RefEdge])

A list of edges.

nodes ([Ref])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


RefEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Ref)

The item at the end of the edge.


ReferencedEvent

Represents areferencedevent on a given ReferencedSubject.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

commit (Commit)

Identifies the commit associated with thereferencedevent.

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

createdAt (DateTime!)

Identifies the date and time when the object was created.

isCrossRepository (Boolean!)

Reference originated in a different repository.

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

subject (ReferencedSubject!)

Object referenced by event.


Release

A release contains the content for a release.

Fields

Name Description

author (User)

The author of the release.

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

Identifies the description of the release.

isDraft (Boolean!)

Whether or not the release is a draft.

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

name (String)

Identifies the title of the release.

publishedAt (DateTime)

Identifies the date and time when the release was created.

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

name (String)

A list of names to filter the assets by.

resourcePath (URI!)

The HTTP path for this issue.

tag (Ref)

The Git tag the release points to.

tagName (String!)

The name of the release's Git tag.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this issue.


ReleaseAsset

A release asset contains the content for a release asset.

Fields

Name Description

contentType (String!)

The asset's content-type.

createdAt (DateTime!)

Identifies the date and time when the object was created.

downloadCount (Int!)

The number of times this asset was downloaded.

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

name (String!)

Identifies the title of the release asset.

release (Release)

Release that the asset is associated with.

size (Int!)

The size (in bytes) of the asset.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

uploadedBy (User!)

The user that performed the upload.

url (URI!)

Identifies the URL of the release asset.


ReleaseAssetConnection

The connection type for ReleaseAsset.

Fields

Name Description

edges ([ReleaseAssetEdge])

A list of edges.

nodes ([ReleaseAsset])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ReleaseAssetEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ReleaseAsset)

The item at the end of the edge.


ReleaseConnection

The connection type for Release.

Fields

Name Description

edges ([ReleaseEdge])

A list of edges.

nodes ([Release])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ReleaseEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Release)

The item at the end of the edge.


RemovedFromProjectEvent

Represents aremoved_from_projectevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

project (Project)

Project referenced by event.

Preview notice

project is available under the Project event details preview. During the preview period, the API may change without notice.

projectColumnName (String!)

Column name referenced by this project event.

Preview notice

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.


RenamedTitleEvent

Represents arenamedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

currentTitle (String!)

Identifies the current title of the issue or pull request.

previousTitle (String!)

Identifies the previous title of the issue or pull request.

subject (RenamedTitleSubject!)

Subject that was renamed.


ReopenedEvent

Represents areopenedevent on any Closable.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

closable (Closable!)

Object that was reopened.

createdAt (DateTime!)

Identifies the date and time when the object was created.


RepoAccessAuditEntry

Audit log entry for a repo.access event.

Preview notice

RepoAccessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.


RepoAddMemberAuditEntry

Audit log entry for a repo.add_member event.

Preview notice

RepoAddMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.


RepoConfigDisableAnonymousGitAccessAuditEntry

Audit log entry for a repo.config.disable_anonymous_git_access event.

Preview notice

RepoConfigDisableAnonymousGitAccessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigDisableCollaboratorsOnlyAuditEntry

Audit log entry for a repo.config.disable_collaborators_only event.

Preview notice

RepoConfigDisableCollaboratorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigDisableContributorsOnlyAuditEntry

Audit log entry for a repo.config.disable_contributors_only event.

Preview notice

RepoConfigDisableContributorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigDisableSockpuppetDisallowedAuditEntry

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

Preview notice

RepoConfigDisableSockpuppetDisallowedAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigEnableAnonymousGitAccessAuditEntry

Audit log entry for a repo.config.enable_anonymous_git_access event.

Preview notice

RepoConfigEnableAnonymousGitAccessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigEnableCollaboratorsOnlyAuditEntry

Audit log entry for a repo.config.enable_collaborators_only event.

Preview notice

RepoConfigEnableCollaboratorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigEnableContributorsOnlyAuditEntry

Audit log entry for a repo.config.enable_contributors_only event.

Preview notice

RepoConfigEnableContributorsOnlyAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigEnableSockpuppetDisallowedAuditEntry

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

Preview notice

RepoConfigEnableSockpuppetDisallowedAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigLockAnonymousGitAccessAuditEntry

Audit log entry for a repo.config.lock_anonymous_git_access event.

Preview notice

RepoConfigLockAnonymousGitAccessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoConfigUnlockAnonymousGitAccessAuditEntry

Audit log entry for a repo.config.unlock_anonymous_git_access event.

Preview notice

RepoConfigUnlockAnonymousGitAccessAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepoRemoveMemberAuditEntry

Audit log entry for a repo.remove_member event.

Preview notice

RepoRemoveMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.


Repository

A repository contains the content for a project.

Fields

Name Description

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

Arguments

affiliation (CollaboratorAffiliation)

Collaborators affiliation level with a repository.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

deployments (DeploymentConnection!)

Deployments associated with the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

environments ([String!])

Environments to list deployments for.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (DeploymentOrder)

Ordering options for deployments returned from the connection.

description (String)

The description of the repository.

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

forks (RepositoryConnection!)

A list of direct forked repositories.

Arguments

affiliations ([RepositoryAffiliation])

Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isLocked (Boolean)

If non-null, filters repositories according to whether they have been locked.

last (Int)

Returns the last n elements from the list.

orderBy (RepositoryOrder)

Ordering options for repositories returned from the connection.

ownerAffiliations ([RepositoryAffiliation])

Array of owner's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.

privacy (RepositoryPrivacy)

If non-null, filters repositories according to privacy.

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

homepageUrl (URI)

The repository's URL.

isArchived (Boolean!)

Indicates if the repository is unmaintained.

isDisabled (Boolean!)

Returns whether or not this repository disabled.

isFork (Boolean!)

Identifies if the repository is a fork.

isLocked (Boolean!)

Indicates if the repository has been locked or not.

isMirror (Boolean!)

Identifies if the repository is a mirror.

isPrivate (Boolean!)

Identifies if the repository is private.

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

issue (Issue)

Returns a single issue from the current repository by number.

Arguments

number (Int!)

The number for the issue to be returned.

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

Arguments

number (Int!)

The number for the issue to be returned.

issues (IssueConnection!)

A list of issues that have been opened in the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

filterBy (IssueFilters)

Filtering options for issues returned from the connection.

first (Int)

Returns the first n elements from the list.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for issues returned from the connection.

states ([IssueState!])

A list of states to filter the issues by.

label (Label)

Returns a single label by name.

Arguments

name (String!)

Label name.

labels (LabelConnection)

A list of labels associated with the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

query (String)

If provided, searches labels by name and description.

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (LanguageOrder)

Order for connection.

licenseInfo (License)

The license associated with the repository.

lockReason (RepositoryLockReason)

The reason the repository has been locked.

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

milestone (Milestone)

Returns a single milestone from the current repository by number.

Arguments

number (Int!)

The number for the milestone to be returned.

milestones (MilestoneConnection)

A list of milestones associated with the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (MilestoneOrder)

Ordering options for milestones.

states ([MilestoneState!])

Filter by the state of the milestones.

mirrorUrl (URI)

The repository's original mirror URL.

name (String!)

The name of the repository.

nameWithOwner (String!)

The repository's name with owner.

object (GitObject)

A Git object in the repository.

Arguments

expression (String)

A Git revision expression suitable for rev-parse.

oid (GitObjectID)

The Git object ID.

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

owner (RepositoryOwner!)

The User owner of the repository.

parent (Repository)

The repository parent, if this is a fork.

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

Preview notice

pinnedIssues is available under the Pinned issues preview. During the preview period, the API may change without notice.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

primaryLanguage (Language)

The primary language of the repository's code.

project (Project)

Find project by number.

Arguments

number (Int!)

The project number to find.

projects (ProjectConnection!)

A list of projects under the owner.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ProjectOrder)

Ordering options for projects returned from the connection.

search (String)

Query to search projects by, currently only searching by name.

states ([ProjectState!])

A list of states to filter the projects by.

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

Arguments

number (Int!)

The number for the pull request to be returned.

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

baseRefName (String)

The base ref name to filter the pull requests by.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

headRefName (String)

The head ref name to filter the pull requests by.

labels ([String!])

A list of label names to filter the pull requests by.

last (Int)

Returns the last n elements from the list.

orderBy (IssueOrder)

Ordering options for pull requests returned from the connection.

states ([PullRequestState!])

A list of states to filter the pull requests by.

pushedAt (DateTime)

Identifies when the repository was last pushed to.

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

ref (Ref)

Fetch a given ref from the repository.

Arguments

qualifiedName (String!)

The ref to retrieve. Fully qualified matches are checked in order (refs/heads/master) before falling back onto checks for short name matches (master).

refs (RefConnection)

Fetch a list of refs from the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

direction (OrderDirection)

DEPRECATED: use orderBy. The ordering direction.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (RefOrder)

Ordering options for refs returned from the connection.

refPrefix (String!)

A ref name prefix like refs/heads/, refs/tags/, etc.

release (Release)

Lookup a single release given various criteria.

Arguments

tagName (String!)

The name of the Tag the Release was created from.

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReleaseOrder)

Order for connection.

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

resourcePath (URI!)

The HTTP path for this repository.

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

Arguments

limit (Int)

How many characters to return.

The default value is 200.

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (StarOrder)

Order for connection.

tempCloneToken (String)

Temporary authentication token for cloning this repository.

Preview notice

tempCloneToken is available under the Temporary cloning token for private repositories preview. During the preview period, the API may change without notice.

templateRepository (Repository)

The repository from which this repository was generated, if any.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this repository.

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

Preview notice

vulnerabilityAlerts is available under the Repository vulnerability alerts preview. During the preview period, the API may change without notice.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

watchers (UserConnection!)

A list of users watching the repository.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.


RepositoryCollaboratorConnection

The connection type for User.

Fields

Name Description

edges ([RepositoryCollaboratorEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


RepositoryCollaboratorEdge

Represents a user who is a collaborator of a repository.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

permission (RepositoryPermission!)

The permission the user has on the repository.

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.


RepositoryConnection

A list of repositories owned by the subject.

Fields

Name Description

edges ([RepositoryEdge])

A list of edges.

nodes ([Repository])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.


RepositoryEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (Repository)

The item at the end of the edge.


RepositoryInvitation

An invitation for a user to be added to a repository.

Fields

Name Description

invitee (User!)

The user who received the invitation.

inviter (User!)

The user who created the invitation.

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

repository (RepositoryInfo)

The Repository the user is invited to.


RepositoryTopic

A repository-topic connects a repository to a topic.

Fields

Name Description

resourcePath (URI!)

The HTTP path for this repository-topic.

topic (Topic!)

The topic.

url (URI!)

The HTTP URL for this repository-topic.


RepositoryTopicConnection

The connection type for RepositoryTopic.

Fields

Name Description

edges ([RepositoryTopicEdge])

A list of edges.

nodes ([RepositoryTopic])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


RepositoryTopicEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (RepositoryTopic)

The item at the end of the edge.


RepositoryVisibilityChangeDisableAuditEntry

Audit log entry for a repository_visibility_change.disable event.

Preview notice

RepositoryVisibilityChangeDisableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepositoryVisibilityChangeEnableAuditEntry

Audit log entry for a repository_visibility_change.enable event.

Preview notice

RepositoryVisibilityChangeEnableAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

enterpriseSlug (String)

The slug of the enterprise.

enterpriseUrl (URI)

The HTTP URL for this enterprise.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


RepositoryVulnerabilityAlert

A alert for a repository with an affected vulnerability.

Preview notice

RepositoryVulnerabilityAlert is available under the Repository vulnerability alerts preview. During the preview period, the API may change without notice.

Fields

Name Description

dismissReason (String)

The reason the alert was dismissed.

dismissedAt (DateTime)

When was the alert dimissed?.

dismisser (User)

The user who dismissed the alert.

repository (Repository!)

The associated repository.

securityAdvisory (SecurityAdvisory)

The associated security advisory.

securityVulnerability (SecurityVulnerability)

The associated security vulnerablity.

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

vulnerableManifestPath (String!)

The vulnerable manifest path.

vulnerableRequirements (String)

The vulnerable requirements.


RepositoryVulnerabilityAlertConnection

The connection type for RepositoryVulnerabilityAlert.

Preview notice

RepositoryVulnerabilityAlertConnection is available under the Repository vulnerability alerts preview. During the preview period, the API may change without notice.

Fields

Name Description

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


RepositoryVulnerabilityAlertEdge

An edge in a connection.

Preview notice

RepositoryVulnerabilityAlertEdge is available under the Repository vulnerability alerts preview. During the preview period, the API may change without notice.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.


RestrictedContribution

Represents a private contribution a user made on GitHub.

Fields

Name Description

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For example, your own 'first issue' contribution may have been made on a repository you can no longer access.

occurredAt (DateTime!)

When this contribution was made.

resourcePath (URI!)

The HTTP path for this contribution.

url (URI!)

The HTTP URL for this contribution.

user (User!)

The user who made this contribution.


ReviewDismissalAllowance

A team or user who has the ability to dismiss a review on a protected branch.

Fields

Name Description

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.


ReviewDismissalAllowanceConnection

The connection type for ReviewDismissalAllowance.

Fields

Name Description

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

nodes ([ReviewDismissalAllowance])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ReviewDismissalAllowanceEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ReviewDismissalAllowance)

The item at the end of the edge.


ReviewDismissedEvent

Represents areview_dismissedevent on a given issue or pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

databaseId (Int)

Identifies the primary key from the database.

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

message (String!)

Identifies the message associated with thereview_dismissedevent.

Deprecation notice

message is deprecated.

message is being removed because it not nullable, whereas the underlying field is optional. Use dismissalMessage instead. Removal on 2019-07-01 UTC.

messageHtml (HTML!)

The message associated with the event, rendered to HTML.

Deprecation notice

messageHtml is deprecated.

messageHtml is being removed because it not nullable, whereas the underlying field is optional. Use dismissalMessageHTML instead. Removal on 2019-07-01 UTC.

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

pullRequest (PullRequest!)

PullRequest referenced by event.

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

resourcePath (URI!)

The HTTP path for this review dismissed event.

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

url (URI!)

The HTTP URL for this review dismissed event.


ReviewRequest

A request for a user to review a pull request.

Fields

Name Description

databaseId (Int)

Identifies the primary key from the database.

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

requestedReviewer (RequestedReviewer)

The reviewer that is requested.


ReviewRequestConnection

The connection type for ReviewRequest.

Fields

Name Description

edges ([ReviewRequestEdge])

A list of edges.

nodes ([ReviewRequest])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


ReviewRequestEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (ReviewRequest)

The item at the end of the edge.


ReviewRequestRemovedEvent

Represents anreview_request_removedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.


ReviewRequestedEvent

Represents anreview_requestedevent on a given pull request.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

pullRequest (PullRequest!)

PullRequest referenced by event.

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.


ReviewStatusHovercardContext

A hovercard context with a message describing the current code review state of the pull request.

Preview notice

ReviewStatusHovercardContext is available under the Hovercards preview. During the preview period, the API may change without notice.

Fields

Name Description

message (String!)

A string describing this context.

octicon (String!)

An octicon to accompany this context.


SearchResultItemConnection

A list of results that matched against a search query.

Fields

Name Description

codeCount (Int!)

The number of pieces of code that matched the search query.

edges ([SearchResultItemEdge])

A list of edges.

issueCount (Int!)

The number of issues that matched the search query.

nodes ([SearchResultItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

repositoryCount (Int!)

The number of repositories that matched the search query.

userCount (Int!)

The number of users that matched the search query.

wikiCount (Int!)

The number of wiki pages that matched the search query.


SearchResultItemEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (SearchResultItem)

The item at the end of the edge.

textMatches ([TextMatch])

Text matches on the result found.


SecurityAdvisory

A GitHub Security Advisory.

Fields

Name Description

databaseId (Int)

Identifies the primary key from the database.

description (String!)

This is a long plaintext description of the advisory.

ghsaId (String!)

The GitHub Security Advisory ID.

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

origin (String!)

The organization that originated the advisory.

publishedAt (DateTime!)

When the advisory was published.

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

summary (String!)

A short plaintext summary of the advisory.

updatedAt (DateTime!)

When the advisory was last updated.

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

ecosystem (SecurityAdvisoryEcosystem)

An ecosystem to filter vulnerabilities by.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

package (String)

A package name to filter vulnerabilities by.

severities ([SecurityAdvisorySeverity!])

A list of severities to filter vulnerabilities by.

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.


SecurityAdvisoryConnection

The connection type for SecurityAdvisory.

Fields

Name Description

edges ([SecurityAdvisoryEdge])

A list of edges.

nodes ([SecurityAdvisory])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


SecurityAdvisoryEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (SecurityAdvisory)

The item at the end of the edge.


SecurityAdvisoryIdentifier

A GitHub Security Advisory Identifier.

Fields

Name Description

type (String!)

The identifier type, e.g. GHSA, CVE.

value (String!)

The identifier.


SecurityAdvisoryPackage

An individual package.

Fields

Name Description

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

name (String!)

The package name.


SecurityAdvisoryPackageVersion

An individual package version.

Fields

Name Description

identifier (String!)

The package name or version.


SecurityAdvisoryReference

A GitHub Security Advisory Reference.

Fields

Name Description

url (URI!)

A publicly accessible reference.


SecurityVulnerability

An individual vulnerability within an Advisory.

Fields

Name Description

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

updatedAt (DateTime!)

When the vulnerability was last updated.

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions. This string follows a basic syntax with a few forms.

  • = 0.2.0 denotes a single vulnerable version.
  • <= 1.0.8 denotes a version range up to and including the specified version
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.


SecurityVulnerabilityConnection

The connection type for SecurityVulnerability.

Fields

Name Description

edges ([SecurityVulnerabilityEdge])

A list of edges.

nodes ([SecurityVulnerability])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


SecurityVulnerabilityEdge

An edge in a connection.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

node (SecurityVulnerability)

The item at the end of the edge.


SmimeSignature

Represents an S/MIME signature on a Commit or Tag.

Fields

Name Description

email (String!)

Email used to sign this object.

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

signature (String!)

ASCII-armored signature header from object.

signer (User)

GitHub user corresponding to the email signing this commit.

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by GitHub, otherwise represents reason why signature is considered invalid.

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.


StargazerConnection

The connection type for User.

Fields

Name Description

edges ([StargazerEdge])

A list of edges.

nodes ([User])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


StargazerEdge

Represents a user that's starred a repository.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

starredAt (DateTime!)

Identifies when the item was starred.


StarredRepositoryConnection

The connection type for Repository.

Fields

Name Description

edges ([StarredRepositoryEdge])

A list of edges.

nodes ([Repository])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


StarredRepositoryEdge

Represents a starred repository.

Fields

Name Description

cursor (String!)

A cursor for use in pagination.

starredAt (DateTime!)

Identifies when the item was starred.


Status

Represents a commit status.

Fields

Name Description

commit (Commit)

The commit this status is attached to.

context (StatusContext)

Looks up an individual status context by context name.

Arguments

name (String!)

The context name.

contexts ([StatusContext!]!)

The individual status contexts for this commit.

state (StatusState!)

The combined commit status.


StatusContext

Represents an individual commit status context.

Fields

Name Description

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

Arguments

size (Int)

The size of the resulting square image.

The default value is 40.

commit (Commit)

This commit this status context is attached to.

context (String!)

The name of this status context.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this status context.

description (String)

The description for this status context.

state (StatusState!)

The state of this status context.

targetUrl (URI)

The URL for this status context.


SubscribedEvent

Represents asubscribedevent on a given Subscribable.

Fields

Name Description

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

subscribable (Subscribable!)

Object referenced by event.


SuggestedReviewer

A suggestion to review a pull request based on a user's commit history and review comments.

Fields

Name Description

isAuthor (Boolean!)

Is this suggestion based on past commits?.

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

reviewer (User!)

Identifies the user suggested to review the pull request.


Tag

Represents a Git tag.

Fields

Name Description

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

commitResourcePath (URI!)

The HTTP path for this Git object.

commitUrl (URI!)

The HTTP URL for this Git object.

message (String)

The Git tag message.

name (String!)

The Git tag name.

oid (GitObjectID!)

The Git object ID.

repository (Repository!)

The Repository the Git object belongs to.

tagger (GitActor)

Details about the tag author.

target (GitObject!)

The Git object the tag points to.


Team

A team of users in an organization.

Fields

Name Description

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

avatarUrl (URI)

A URL pointing to the team's avatar.

Arguments

size (Int)

The size in pixels of the resulting square image.

The default value is 400.

childTeams (TeamConnection!)

List of child teams belonging to this team.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

immediateOnly (Boolean)

Whether to list immediate child teams or all descendant child teams.

The default value is true.

last (Int)

Returns the last n elements from the list.

orderBy (TeamOrder)

Order for connection.

userLogins ([String!])

User logins to filter by.

combinedSlug (String!)

The slug corresponding to the organization and team.

createdAt (DateTime!)

Identifies the date and time when the object was created.

description (String)

The description of the team.

discussion (TeamDiscussion)

Find a team discussion by its number.

Preview notice

discussion is available under the Team discussions preview. During the preview period, the API may change without notice.

Arguments

number (Int!)

The sequence number of the discussion to find.

discussions (TeamDiscussionConnection!)

A list of team discussions.

Preview notice

discussions is available under the Team discussions preview. During the preview period, the API may change without notice.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

isPinned (Boolean)

If provided, filters discussions according to whether or not they are pinned.

last (Int)

Returns the last n elements from the list.

orderBy (TeamDiscussionOrder)

Order for connection.

discussionsResourcePath (URI!)

The HTTP path for team discussions.

Preview notice

discussionsResourcePath is available under the Team discussions preview. During the preview period, the API may change without notice.

discussionsUrl (URI!)

The HTTP URL for team discussions.

Preview notice

discussionsUrl is available under the Team discussions preview. During the preview period, the API may change without notice.

editTeamResourcePath (URI!)

The HTTP path for editing this team.

editTeamUrl (URI!)

The HTTP URL for editing this team.

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (UserStatusOrder)

Ordering options for user statuses returned from the connection.

members (TeamMemberConnection!)

A list of users who are members of this team.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

membership (TeamMembershipType)

Filter by membership type.

The default value is ALL.

orderBy (TeamMemberOrder)

Order for the connection.

query (String)

The search string to look for.

role (TeamMemberRole)

Filter by team member role.

membersResourcePath (URI!)

The HTTP path for the team' members.

membersUrl (URI!)

The HTTP URL for the team' members.

name (String!)

The name of the team.

newTeamResourcePath (URI!)

The HTTP path creating a new team.

newTeamUrl (URI!)

The HTTP URL creating a new team.

organization (Organization!)

The organization that owns this team.

parentTeam (Team)

The parent team of the team.

privacy (TeamPrivacy!)

The level of privacy the team has.

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (TeamRepositoryOrder)

Order for the connection.

query (String)

The search string to look for.

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

resourcePath (URI!)

The HTTP path for this team.

slug (String!)

The slug corresponding to the team.

teamsResourcePath (URI!)

The HTTP path for this team's teams.

teamsUrl (URI!)

The HTTP URL for this team's teams.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this team.

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.


TeamAddMemberAuditEntry

Audit log entry for a team.add_member event.

Preview notice

TeamAddMemberAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

team (Team)

The team associated with the action.

teamName (String)

The name of the team.

teamResourcePath (URI)

The HTTP path for this team.

teamUrl (URI)

The HTTP URL for this team.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


TeamAddRepositoryAuditEntry

Audit log entry for a team.add_repository event.

Preview notice

TeamAddRepositoryAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

repository (Repository)

The repository associated with the action.

repositoryName (String)

The name of the repository.

repositoryResourcePath (URI)

The HTTP path for the repository.

repositoryUrl (URI)

The HTTP URL for the repository.

team (Team)

The team associated with the action.

teamName (String)

The name of the team.

teamResourcePath (URI)

The HTTP path for this team.

teamUrl (URI)

The HTTP URL for this team.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


TeamChangeParentTeamAuditEntry

Audit log entry for a team.change_parent_team event.

Preview notice

TeamChangeParentTeamAuditEntry is available under the Audit log preview. During the preview period, the API may change without notice.

Fields

Name Description

action (String!)

The action name.

actor (AuditEntryActor)

The user who initiated the action.

actorIp (String)

The IP address of the actor.

actorLocation (ActorLocation)

A readable representation of the actor's location.

Preview notice

actorLocation is available under the Audit log preview. During the preview period, the API may change without notice.

actorLogin (String)

The username of the user who initiated the action.

actorResourcePath (URI)

The HTTP path for the actor.

actorUrl (URI)

The HTTP URL for the actor.

createdAt (PreciseDateTime!)

The time the action was initiated.

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

organization (Organization)

The Organization associated with the Audit Entry.

organizationName (String)

The name of the Organization.

organizationResourcePath (URI)

The HTTP path for the organization.

organizationUrl (URI)

The HTTP URL for the organization.

parentTeam (Team)

The new parent team.

parentTeamName (String)

The name of the new parent team.

parentTeamNameWas (String)

The name of the former parent team.

parentTeamResourcePath (URI)

The HTTP path for the parent team.

parentTeamUrl (URI)

The HTTP URL for the parent team.

parentTeamWas (Team)

The former parent team.

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

team (Team)

The team associated with the action.

teamName (String)

The name of the team.

teamResourcePath (URI)

The HTTP path for this team.

teamUrl (URI)

The HTTP URL for this team.

user (User)

The user affected by the action.

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

userResourcePath (URI)

The HTTP path for the user.

userUrl (URI)

The HTTP URL for the user.


TeamConnection

The connection type for Team.

Fields

Name Description

edges ([TeamEdge])

A list of edges.

nodes ([Team])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.


TeamDiscussion

A team discussion.

Preview notice

TeamDiscussion is available under the Team discussions preview. During the preview period, the API may change without notice.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The discussion body rendered to HTML.

bodyText (String!)

The body rendered to text.

bodyVersion (String!)

Identifies the discussion body hash.

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

fromComment (Int)

When provided, filters the connection such that results begin with the comment with this number.

last (Int)

Returns the last n elements from the list.

orderBy (TeamDiscussionCommentOrder)

Order for connection.

commentsResourcePath (URI!)

The HTTP path for discussion comments.

commentsUrl (URI!)

The HTTP URL for discussion comments.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

isPinned (Boolean!)

Whether or not the discussion is pinned.

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

lastEditedAt (DateTime)

The moment the editor made the last edit.

number (Int!)

Identifies the discussion within its team.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

resourcePath (URI!)

The HTTP path for this discussion.

team (Team!)

The team that defines the context of this discussion.

title (String!)

The title of the discussion.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this discussion.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.


TeamDiscussionComment

A comment on a team discussion.

Preview notice

TeamDiscussionComment is available under the Team discussions preview. During the preview period, the API may change without notice.

Fields

Name Description

author (Actor)

The actor who authored the comment.

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

body (String!)

The body as Markdown.

bodyHTML (HTML!)

The comment body rendered to HTML.

bodyText (String!)

The body rendered to text.

bodyVersion (String!)

The current version of the body content.

createdAt (DateTime!)

Identifies the date and time when the object was created.

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

databaseId (Int)

Identifies the primary key from the database.

discussion (TeamDiscussion!)

The discussion this comment is about.

editor (Actor)

The actor who edited the comment.

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

lastEditedAt (DateTime)

The moment the editor made the last edit.

number (Int!)

Identifies the comment number.

publishedAt (DateTime)

Identifies when the comment was published at.

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

content (ReactionContent)

Allows filtering Reactions by emoji.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

orderBy (ReactionOrder)

Allows specifying the order in which reactions are returned.

resourcePath (URI!)

The HTTP path for this comment.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI!)

The HTTP URL for this comment.

userContentEdits (UserContentEditConnection)

A list of edits to this content.

Arguments

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

viewerCanReact (Boolean!)

Can user react to this subject.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

viewerDidAuthor (Boolean!)

Did the viewer author this comment.