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.
Fields
| Name | Description |
|---|---|
|
City. |
|
Country name. |
|
Country code. |
|
Region name. |
|
Region or state code. |
AddedToProjectEvent
Represents aadded_to_projectevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
Project referenced by event. Preview notice
|
|
Project card referenced by this project event. Preview notice
|
|
Column name referenced by this project event. Preview notice
|
App
A GitHub App.
Fields
| Name | Description |
|---|---|
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
The description of the app. |
|
The hex color code, without the leading '#', for the logo background. |
|
A URL pointing to the app's logo. Arguments
The size of the resulting image. |
|
The name of the app. |
|
A slug based on the name of the app for use in URLs. |
|
Identifies the date and time when the object was last updated. |
|
The URL to the app's homepage. |
AssignedEvent
Represents anassignedevent on any assignable object.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the assignable associated with the event. |
|
Identifies the user or mannequin that was assigned. |
|
Identifies the date and time when the object was created. |
|
Identifies the user who was assigned. Deprecation notice
Assignees can now be mannequins. Use the |
BaseRefChangedEvent
Represents abase_ref_changedevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
BaseRefForcePushedEvent
Represents abase_ref_force_pushedevent on a given pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the after commit SHA for the |
|
Identifies the before commit SHA for the |
|
Identifies the date and time when the object was created. |
|
PullRequest referenced by event. |
|
Identifies the fully qualified ref name for the |
Blame
Represents a Git blame.
Fields
| Name | Description |
|---|---|
|
The list of ranges from a Git blame. |
BlameRange
Represents a range of information from a Git blame.
Fields
| Name | Description |
|---|---|
|
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. |
|
Identifies the line author. |
|
The ending line for the range. |
|
The starting line for the range. |
Blob
Represents a Git blob.
Fields
| Name | Description |
|---|---|
|
An abbreviated version of the Git object ID. |
|
Byte size of Blob object. |
|
The HTTP path for this Git object. |
|
The HTTP URL for this Git object. |
|
Indicates whether the Blob is binary or text. |
|
Indicates whether the contents is truncated. |
|
The Git object ID. |
|
The Repository the Git object belongs to. |
|
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 |
|---|---|
|
A URL pointing to the GitHub App's public avatar. Arguments
The size of the resulting square image. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
The username of the actor. |
|
The HTTP path for this bot. |
|
Identifies the date and time when the object was last updated. |
|
The HTTP URL for this bot. |
BranchProtectionRule
A branch protection rule.
Fields
| Name | Description |
|---|---|
|
A list of conflicts matching branches protection rule and other branch protection rules. |
|
The actor who created this branch protection rule. |
|
Identifies the primary key from the database. |
|
Will new commits pushed to matching branches dismiss pull request review approvals. |
|
Can admins overwrite branch protection. |
|
Repository refs that are protected by this rule. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Filters refs with query on name. |
|
Identifies the protection rule pattern. |
|
A list push allowances for this branch protection rule. |
|
The repository associated with this branch protection rule. |
|
Number of approving reviews required to update matching branches. |
|
List of required status check contexts that must pass for commits to be accepted to matching branches. |
|
Are approving reviews required to update matching branches. |
|
Are reviews from code owners required to update matching branches. |
|
Are commits required to be signed. |
|
Are status checks required to update matching branches. |
|
Are branches required to be up to date before merging. |
|
Is pushing to matching branches restricted. |
|
Is dismissal of pull request reviews restricted. |
|
A list review dismissal allowances for this branch protection rule. |
BranchProtectionRuleConflict
A conflict between two branch protection rules.
Fields
| Name | Description |
|---|---|
|
Identifies the branch protection rule. |
|
Identifies the conflicting branch protection rule. |
|
Identifies the branch ref that has conflicting rules. |
BranchProtectionRuleConflictConnection
The connection type for BranchProtectionRuleConflict.
Fields
| Name | Description |
|---|---|
A list of edges. |
|
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
BranchProtectionRuleConflictEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
BranchProtectionRuleConnection
The connection type for BranchProtectionRule.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
BranchProtectionRuleEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
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 |
|---|---|
|
The annotation's severity level. |
|
The path to the file that this annotation was made on. |
|
Identifies the primary key from the database. |
|
The position of this annotation. |
|
The annotation's message. |
|
The path that this annotation was made on. |
|
Additional information about the annotation. |
|
The annotation's title. |
CheckAnnotationConnection
The connection type for CheckAnnotation.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. Preview notice
|
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CheckAnnotationEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. Preview 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 number (1 indexed). |
|
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 position (inclusive). |
|
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 |
|---|---|
|
The check run's annotations. |
|
The check suite that this run is a part of. |
|
Identifies the date and time when the check run was completed. |
|
The conclusion of the check run. |
|
Identifies the primary key from the database. |
|
The URL from which to find full details of the check run on the integrator's site. |
|
A reference for the check run on the integrator's system. |
|
The name of the check for this check run. |
|
The permalink to the check run summary. |
|
The repository associated with this check run. |
|
The HTTP path for this check run. |
|
Identifies the date and time when the check run was started. |
|
The current status of the check run. |
|
A string representing the check run's summary. |
|
A string representing the check run's text. |
|
A string representing the check run. |
|
The HTTP URL for this check run. |
CheckRunConnection
The connection type for CheckRun.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. Preview notice
|
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CheckRunEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. Preview 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 |
|---|---|
|
The GitHub App which created this check suite. |
|
The name of the branch for this check suite. |
|
The check runs associated with a check suite. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Filters the check runs by this type.
Returns the first n elements from the list.
Returns the last n elements from the list. |
|
The commit for this check suite. |
|
The conclusion of this check suite. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
A list of open pull requests matching the check suite. Arguments
Returns the elements in the list that come after the specified cursor.
The base ref name to filter the pull requests by.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
The head ref name to filter the pull requests by.
A list of label names to filter the pull requests by.
Returns the last n elements from the list.
Ordering options for pull requests returned from the connection.
A list of states to filter the pull requests by. |
|
The push that triggered this check suite. |
|
The repository associated with this check suite. |
|
The HTTP path for this check suite. |
|
The status of this check suite. |
|
Identifies the date and time when the object was last updated. |
|
The HTTP URL for this check suite. |
CheckSuiteConnection
The connection type for CheckSuite.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. Preview notice
|
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CheckSuiteEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. Preview notice
|
ClosedEvent
Represents aclosedevent on any Closable.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Object that was closed. |
|
Object which triggered the creation of this event. |
|
Identifies the date and time when the object was created. |
|
The HTTP path for this closed event. |
|
The HTTP URL for this closed event. |
CodeOfConduct
The Code of Conduct for a repository.
Fields
| Name | Description |
|---|---|
|
The body of the Code of Conduct. |
|
The key for the Code of Conduct. |
|
The formal name of the Code of Conduct. |
|
The HTTP path for this Code of Conduct. |
|
The HTTP URL for this Code of Conduct. |
CommentDeletedEvent
Represents acomment_deletedevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
Commit
Represents a Git commit.
Fields
| Name | Description |
|---|---|
|
An abbreviated version of the Git object ID. |
|
The number of additions in this commit. |
|
The pull requests associated with a commit. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for pull requests. |
|
Authorship details of the commit. |
|
Check if the committer and the author match. |
|
The datetime when this commit was authored. |
|
Fetches Arguments
The file whose Git blame information you want. |
|
The number of changed files in this commit. |
|
The check suites associated with a commit. Preview notice
Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Filters the check suites by this type.
Returns the first n elements from the list.
Returns the last n elements from the list. |
|
Comments made on the commit. |
|
The HTTP path for this Git object. |
|
The HTTP URL for this Git object. |
|
The datetime when this commit was committed. |
|
Check if commited via GitHub web UI. |
|
Committership details of the commit. |
|
The number of deletions in this commit. |
|
The deployments associated with a commit. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Environments to list deployments for.
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for deployments returned from the connection. |
|
The linear commit history starting from (and including) this commit, in the same order as Arguments
Returns the elements in the list that come after the specified cursor.
If non-null, filters history to only show commits with matching authorship.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
If non-null, filters history to only show commits touching files under this path.
Allows specifying a beginning time or date for fetching commits.
Allows specifying an ending time or date for fetching commits. |
|
The Git commit message. |
|
The Git commit message body. |
|
The commit message body rendered to HTML. |
|
The Git commit message headline. |
|
The commit message headline rendered to HTML. |
|
The Git object ID. |
|
The organization this commit was made on behalf of. |
|
The parents of a commit. |
|
The datetime when this commit was pushed. |
|
The Repository this commit belongs to. |
|
The HTTP path for this commit. |
|
Commit signing information, if present. |
|
Status information for this commit. |
|
Check and Status rollup information for this commit. |
|
Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file. |
|
Returns a URL to download a tarball archive for a repository. Note: For private repositories, these links are temporary and expire after five minutes. |
|
Commit's root Tree. |
|
The HTTP path for the tree of this commit. |
|
The HTTP URL for the tree of this commit. |
|
The HTTP URL for this commit. |
|
Check if the viewer is able to change their subscription status for the repository. |
|
Identifies if the viewer is watching, not watching, or ignoring the subscribable entity. |
|
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 |
|---|---|
|
The actor who authored the comment. |
|
Author's association with the subject of the comment. |
|
Identifies the comment body. |
|
The body rendered to HTML. |
|
The body rendered to text. |
|
Identifies the commit associated with the comment, if the commit exists. |
|
Identifies the date and time when the object was created. |
|
Check if this comment was created via an email reply. |
|
Identifies the primary key from the database. |
|
The actor who edited the comment. |
|
Check if this comment was edited and includes an edit with the creation data. |
|
Returns whether or not a comment has been minimized. |
|
The moment the editor made the last edit. |
|
Returns why the comment was minimized. |
|
Identifies the file path associated with the comment. |
|
Identifies the line position associated with the comment. |
|
Identifies when the comment was published at. |
|
A list of reactions grouped by content left on the subject. |
|
A list of Reactions left on the Issue. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Allows filtering Reactions by emoji.
Returns the first n elements from the list.
Returns the last n elements from the list.
Allows specifying the order in which reactions are returned. |
|
The repository associated with this node. |
|
The HTTP path permalink for this commit comment. |
|
Identifies the date and time when the object was last updated. |
|
The HTTP URL permalink for this commit comment. |
|
A list of edits to this content. |
|
Check if the current viewer can delete this object. |
|
Check if the current viewer can minimize this object. |
|
Can user react to this subject. |
|
Check if the current viewer can update this object. |
|
Reasons why the current viewer can not update this comment. |
|
Did the viewer author this comment. |
CommitCommentConnection
The connection type for CommitComment.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CommitCommentEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
CommitCommentThread
A thread of comments on a commit.
Fields
| Name | Description |
|---|---|
|
The comments that exist in this thread. |
|
The commit the comments were made on. |
|
The file the comments were made on. |
|
The position in the diff for the commit that the comment was made on. |
|
The repository associated with this node. |
CommitConnection
The connection type for Commit.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
CommitContributionsByRepository
This aggregates commits made by a user within one repository.
Fields
| Name | Description |
|---|---|
|
The commit contributions, each representing a day. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for commit contributions returned from the connection. |
|
The repository in which the commits were made. |
|
The HTTP path for the user's commits to the repository in this time range. |
|
The HTTP URL for the user's commits to the repository in this time range. |
CommitEdge
An edge in a connection.
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
CommitHistoryConnection
The connection type for Commit.
Fields
| Name | Description |
|---|---|
|
A list of edges. |
|
A list of nodes. |
|
Information to aid in pagination. |
|
Identifies the total count of items in the connection. |
ConnectedEvent
Represents aconnectedevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Reference originated in a different repository. |
|
Issue or pull request that made the reference. |
|
Issue or pull request which was connected. |
ContentAttachment
A content attachment.
Fields
| Name | Description |
|---|---|
|
The body text of the content attachment. This parameter supports markdown. |
|
The content reference that the content attachment is attached to. |
|
Identifies the primary key from the database. |
|
The title of the content attachment. |
ContentReference
A content reference.
Fields
| Name | Description |
|---|---|
|
Identifies the primary key from the database. |
|
The reference of the content reference. |
ContributionCalendar
A calendar of contributions made on GitHub by a user.
Fields
| Name | Description |
|---|---|
|
A list of hex color codes used in this calendar. The darker the color, the more contributions it represents. |
|
Determine if the color set was chosen because it's currently Halloween. |
|
A list of the months of contributions in this calendar. |
|
The count of total contributions in the calendar. |
|
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 |
|---|---|
|
The hex color code that represents how many contributions were made on this day compared to others in the calendar. |
|
How many contributions were made by the user on this day. |
|
The day this square represents. |
|
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 |
|---|---|
|
The date of the first day of this month. |
|
The name of the month. |
|
How many weeks started in this month. |
|
The year the month occurred in. |
ContributionCalendarWeek
A week of contributions in a user's contribution graph.
Fields
| Name | Description |
|---|---|
|
The days of contributions in this week. |
|
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 |
|---|---|
|
Commit contributions made by the user, grouped by repository. Arguments |
|
A calendar of this user's contributions on GitHub. |
|
The years the user has been making contributions with the most recent year first. |
|
Determine if this collection's time span ends in the current month. |
|
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. |
|
The ending date and time of this collection. |
|
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. |
|
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. |
|
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. |
|
Does the user have any more activity in the timeline that occurred prior to the collection's time range?. |
|
Determine if there are any contributions in this collection. |
|
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. |
|
Whether or not the collector's time span is all within the same day. |
|
A list of issues the user opened. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Should the user's first issue ever be excluded from the result. The default value is
Should the user's most commented issue be excluded from the result. The default value is
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for contributions returned from the connection. |
|
Issue contributions made by the user, grouped by repository. |
|
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. |
|
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. |
|
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. |
|
Returns a different contributions collection from an earlier time range than this one that does not have any contributions. |
|
The issue the user opened on GitHub that received the most comments in the specified time frame. |
|
The pull request the user opened on GitHub that received the most comments in the specified time frame. |
|
Pull request contributions made by the user. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Should the user's first pull request ever be excluded from the result. The default value is
Should the user's most commented pull request be excluded from the result. The default value is
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for contributions returned from the connection. |
|
Pull request contributions made by the user, grouped by repository. |
|
Pull request review contributions made by the user. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for contributions returned from the connection. |
|
Pull request review contributions made by the user, grouped by repository. Arguments |
|
A list of repositories owned by the user that the user created in this time range. Arguments
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Should the user's first repository ever be excluded from the result. The default value is
Returns the first n elements from the list.
Returns the last n elements from the list.
Ordering options for contributions returned from the connection. |
|
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. |
|
The beginning date and time of this collection. |
|
How many commits were made by the user in this time span. |
|
How many issues the user opened. |
|
How many pull requests the user opened. |
|
How many pull request reviews the user left. |
|
How many different repositories the user committed to. |
|
How many different repositories the user opened issues in. |
|
How many different repositories the user left pull request reviews in. |
|
How many different repositories the user opened pull requests in. |
|
How many repositories the user created. Arguments
Should the user's first repository ever be excluded from this count. The default value is |
|
The user who made the contributions in this collection. |
ConvertToDraftEvent
Represents aconvert_to_draftevent on a given pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
PullRequest referenced by event. |
|
The HTTP path for this convert to draft event. |
|
The HTTP URL for this convert to draft event. |
ConvertedNoteToIssueEvent
Represents aconverted_note_to_issueevent on a given issue or pull request.
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the primary key from the database. |
|
Project referenced by event. Preview notice
|
|
Project card |