Objects

Objects in GraphQL represent the resources you can access.

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.

ActorConnection

The connection type for Actor.

Fields for ActorConnection

NameDescription

edges ([ActorEdge])

A list of edges.

nodes ([Actor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ActorEdge

An edge in a connection.

Fields for ActorEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Actor)

The item at the end of the edge.

ActorLocation

Location information for an actor.

Fields for ActorLocation

NameDescription

city (String)

City.

country (String)

Country name.

countryCode (String)

Country code.

region (String)

Region name.

regionCode (String)

Region or state code.

AddedToMergeQueueEvent

Represents anadded_to_merge_queueevent on a given pull request.

AddedToMergeQueueEvent Implements

Fields for AddedToMergeQueueEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enqueuer (User)

The user who added this Pull Request to the merge queue.

id (ID!)

The Node ID of the AddedToMergeQueueEvent object.

mergeQueue (MergeQueue)

The merge queue where this pull request was added to.

pullRequest (PullRequest)

PullRequest referenced by event.

AddedToProjectEvent

Represents aadded_to_projectevent on a given issue or pull request.

AddedToProjectEvent Implements

Fields for AddedToProjectEvent

NameDescription

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.

Warning

databaseId is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

id (ID!)

The Node ID of the AddedToProjectEvent object.

project (Project)

Project referenced by event.

Warning

project is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

projectCard (ProjectCard)

Project card referenced by this project event.

Warning

projectCard is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

projectColumnName (String!)

Column name referenced by this project event.

Warning

projectColumnName is deprecated.

Projects (classic) is being deprecated in favor of the new Projects experience, see: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/. Removal on 2025-04-01 UTC.

AnnouncementBanner

An announcement banner for an enterprise or organization.

Fields for AnnouncementBanner

NameDescription

createdAt (DateTime!)

The date the announcement was created.

expiresAt (DateTime)

The expiration date of the announcement, if any.

isUserDismissible (Boolean!)

Whether the announcement can be dismissed by the user.

message (String)

The text of the announcement.

App

A GitHub App.

App Implements

Fields for App

NameDescription

clientId (String)

The client ID of the app.

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.

id (ID!)

The Node ID of the App object.

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses of the app.

Arguments for ipAllowListEntries

  • 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.

logoBackgroundColor (String!)

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

logoUrl (URI!)

A URL pointing to the app's logo.

Arguments for logoUrl

  • 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.

AssignedEvent Implements

Fields for AssignedEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

assignable (Assignable!)

Identifies the assignable associated with the event.

assignee (Assignee)

Identifies the user or mannequin that was assigned.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AssignedEvent object.

user (User)

Identifies the user who was assigned.

Warning

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

AssigneeConnection

The connection type for Assignee.

Fields for AssigneeConnection

NameDescription

edges ([AssigneeEdge])

A list of edges.

nodes ([Assignee])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

AssigneeEdge

An edge in a connection.

Fields for AssigneeEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Assignee)

The item at the end of the edge.

AutoMergeDisabledEvent

Represents aauto_merge_disabledevent on a given pull request.

AutoMergeDisabledEvent Implements

Fields for AutoMergeDisabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

disabler (User)

The user who disabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeDisabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

reason (String)

The reason auto-merge was disabled.

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

AutoMergeEnabledEvent

Represents aauto_merge_enabledevent on a given pull request.

AutoMergeEnabledEvent Implements

Fields for AutoMergeEnabledEvent

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

enabler (User)

The user who enabled auto-merge for this Pull Request.

id (ID!)

The Node ID of the AutoMergeEnabledEvent object.

pullRequest (PullRequest)

PullRequest referenced by event.

AutoMergeRequest

Represents an auto-merge request for a pull request.

Fields for AutoMergeRequest

NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

commitBody (String)

The commit message of the auto-merge request. If a merge queue is required by the base branch, this value will be set by the merge queue when merging.

commitHeadline (