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."
Fields
| Name | Description |
|---|---|
|
City. |
|
Country name. |
|
Country code. |
|
Region name. |
|
Region or state code. |
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
|
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 IP addresses of the app. 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 IP allow list entries returned. |
|
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. |
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 |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
The user who disabled auto-merge for this Pull Request. |
|
PullRequest referenced by event. |
|
The reason auto-merge was disabled. |
|
The reason_code relating to why auto-merge was disabled. |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
The user who enabled auto-merge for this Pull Request. |
|
PullRequest referenced by event. |
Fields
| Name | Description |
|---|---|
|
The email address of the author of this auto-merge request. |
|
The commit message of the auto-merge request. |
|
The commit title of the auto-merge request. |
|
When was this auto-merge request was enabled. |
|
The actor who created the auto-merge request. |
|
The merge method of the auto-merge request. |
|
The pull request that this auto-merge request is set against. |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
The user who enabled auto-merge (rebase) for this Pull Request. |
|
PullRequest referenced by event. |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
The user who enabled auto-merge (squash) for this Pull Request. |
|
PullRequest referenced by event. |
AutomaticBaseChangeFailedEvent
Represents aautomatic_base_change_failedevent 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. |
|
The new base for this PR. |
|
The old base for this PR. |
|
PullRequest referenced by event. |
AutomaticBaseChangeSucceededEvent
Represents aautomatic_base_change_succeededevent 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. |
|
The new base for this PR. |
|
The old base for this PR. |
|
PullRequest referenced by event. |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the date and time when the object was created. |
|
Identifies the name of the base ref for the pull request after it was changed. |
|
Identifies the primary key from the database. |
|
Identifies the name of the base ref for the pull request before it was changed. |
|
PullRequest referenced by event. |
Fields
| Name | Description |
|---|---|
|
Identifies the actor who performed the event. |
|
Identifies the name of the Ref associated with the |
|
Identifies the date and time when the object was created. |
|
PullRequest referenced by event. |
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 |
Fields
| Name | Description |
|---|---|
|
The list of ranges 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. |
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. Returns null if unable to determine the encoding. |
|
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. |
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. |
Fields
| Name | Description |
|---|---|
|
Can this branch be deleted. |
|
Are force pushes allowed on this branch. |
|
A list of conflicts matching branches protection rule and other branch protection rules. |
|
A list of actors able to force push for this branch protection rule. |
|
A list of actors able to bypass PRs for this branch protection rule. |
|
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. |
|
List of required status checks 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 conversations required to be resolved before merging. |
|
Are merge commits prohibited from being pushed to this branch. |
|
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. |
Fields
| Name | Description |
|---|---|
|
Identifies the branch protection rule. |
|
Identifies the conflicting branch protection rule. |
|
Identifies the branch ref that has conflicting rules. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
BypassForcePushAllowance
A team or user who has the ability to bypass a force push requirement on a protected branch.
Fields
| Name | Description |
|---|---|
|
The actor that can dismiss. |
|
Identifies the branch protection rule associated with the allowed user or team. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
BypassPullRequestAllowance
A team or user who has the ability to bypass a pull request requirement on a protected branch.
Fields
| Name | Description |
|---|---|
|
The actor that can dismiss. |
|
Identifies the branch protection rule associated with the allowed user or team. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
Fields
| Name | Description |
|---|---|
|
The CVSS score associated with this advisory. |
|
The CVSS vector string associated with this advisory. |
Fields
| Name | Description |
|---|---|
|
The id of the CWE. |
|
A detailed description of this CWE. |
|
The name of this CWE. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
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. |
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. |
Fields
| Name | Description |
|---|---|
|
A cursor for use in pagination. |
|
The item at the end of the edge. |
Fields
| Name | Description |
|---|---|
|
Column number (1 indexed). |
|
Line number (1 indexed). |
Fields
| Name | Description |
|---|---|
|
End position (inclusive). |
|
Start position (inclusive). |
Fields
| Name | Description |
|---|---|
|
The check run's annotations. |
|
The check suite that this run is a part of. |