Reference documentation for GraphQL schema types in the Projects (classic) category.

In this article

Mutations

addProjectCard

Mutation

Adds a card to a ProjectColumn. Either contentId or note must be provided but not both.

Warning

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

Input fields for addProjectCard

Return fields for addProjectCard

NameDescription

cardEdge (ProjectCardEdge)

The edge from the ProjectColumn's card connection.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The ProjectColumn.

addProjectColumn

Mutation

Adds a column to a Project.

Warning

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

Input fields for addProjectColumn

Return fields for addProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The edge from the project's column connection.

project (Project)

The project.

cloneProject

Mutation

Creates a new project by cloning configuration from an existing project.

Warning

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

Input fields for cloneProject

Return fields for cloneProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

jobStatusId (String)

The id of the JobStatus for populating cloned fields.

project (Project)

The new cloned project.

convertProjectCardNoteToIssue

Mutation

Convert a project note card to one associated with a newly created issue.

Warning

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

Input fields for convertProjectCardNoteToIssue

Return fields for convertProjectCardNoteToIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

createProject

Mutation

Creates a new project.

Warning

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

Input fields for createProject

Return fields for createProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The new project.

deleteProject

Mutation

Deletes a project.

Warning

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

Input fields for deleteProject

Return fields for deleteProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

owner (ProjectOwner)

The repository or organization the project was removed from.

deleteProjectCard

Mutation

Deletes a project card.

Warning

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

Input fields for deleteProjectCard

Return fields for deleteProjectCard

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

column (ProjectColumn)

The column the deleted card was in.

deletedCardId (ID)

The deleted card ID.

deleteProjectColumn

Mutation

Deletes a project column.

Warning

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

Input fields for deleteProjectColumn

Return fields for deleteProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedColumnId (ID)

The deleted column ID.

project (Project)

The project the deleted column was in.

linkRepositoryToProject

Mutation

Creates a repository link for a project.

Warning

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

Input fields for linkRepositoryToProject

Return fields for linkRepositoryToProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

moveProjectCard

Mutation

Moves a project card to another place.

Warning

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

Input fields for moveProjectCard

Return fields for moveProjectCard

NameDescription

cardEdge (ProjectCardEdge)

The new edge of the moved card.

clientMutationId (String)

A unique identifier for the client performing the mutation.

moveProjectColumn

Mutation

Moves a project column to another place.

Warning

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

Input fields for moveProjectColumn

Return fields for moveProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnEdge (ProjectColumnEdge)

The new edge of the moved column.

unlinkRepositoryFromProject

Mutation

Deletes a repository link from a project.

Warning

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

Input fields for unlinkRepositoryFromProject

Return fields for unlinkRepositoryFromProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The linked Project.

repository (Repository)

The linked Repository.

updateProject

Mutation

Updates an existing project.

Warning

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

Input fields for updateProject

Return fields for updateProject

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

project (Project)

The updated project.

updateProjectCard

Mutation

Updates an existing project card.

Warning

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

Input fields for updateProjectCard

Return fields for updateProjectCard

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCard (ProjectCard)

The updated ProjectCard.

updateProjectColumn

Mutation

Updates an existing project column.

Warning

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

Input fields for updateProjectColumn

Return fields for updateProjectColumn

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectColumn (ProjectColumn)

The updated project column.

Objects

AddedToProjectEvent

Object

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.

MovedColumnsInProjectEvent

Object

Represents amoved_columns_in_projectevent on a given issue or pull request.

MovedColumnsInProjectEvent Implements

Fields for MovedColumnsInProjectEvent

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 MovedColumnsInProjectEvent object.

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

Warning

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

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 the issue or pull request was moved to.

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.

Project

Object

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

Project Implements

Fields for Project

NameDescription

body (String)

The project's description body.

Warning

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

bodyHTML (HTML!)

The projects description body rendered to HTML.

Warning

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

closed (Boolean!)

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

Warning

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

Arguments for columns

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

Warning

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

creator (Actor)

The actor who originally created the project.

Warning

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

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 Project object.

Warning

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

name (String!)

The project's name.

Warning

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

number (Int!)

The project's number.

Warning

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

owner (ProjectOwner!)

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

Warning

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

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

Warning

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

Arguments for pendingCards

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

progress (ProjectProgress!)

Project progress details.

Warning

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

resourcePath (URI!)

The HTTP path for this project.

Warning

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

state (ProjectState!)

Whether the project is open or closed.

Warning

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

updatedAt (DateTime!)

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

Warning

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

url (URI!)

The HTTP URL for this project.

Warning

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

viewerCanClose (Boolean!)

Indicates if the object can be closed by the viewer.

viewerCanReopen (Boolean!)

Indicates if the object can be reopened by the viewer.

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

ProjectCard

Object

A card in a project.

ProjectCard Implements

Fields for ProjectCard

NameDescription

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.

Warning

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

content (ProjectCardItem)

The card content item.

Warning

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

Warning

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

creator (Actor)

The actor who created this card.

Warning

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

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 ProjectCard object.

Warning

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

isArchived (Boolean!)

Whether the card is archived.

Warning

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

note (String)

The card note.

Warning

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

project (Project!)

The project that contains this card.

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.

resourcePath (URI!)

The HTTP path for this card.

Warning

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

state (ProjectCardState)

The state of ProjectCard.

Warning

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

updatedAt (DateTime!)

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

Warning

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

url (URI!)

The HTTP URL for this card.

Warning

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

ProjectCardConnection

Object

The connection type for ProjectCard.

Fields for ProjectCardConnection

NameDescription

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

Object

An edge in a connection.

Fields for ProjectCardEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (ProjectCard)

The item at the end of the edge.

ProjectColumn

Object

A column inside a project.

ProjectColumn Implements

Fields for ProjectColumn

NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

Warning

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

Arguments for cards

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

Warning

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

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 ProjectColumn object.

Warning

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

name (String!)

The project column's name.

Warning

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

project (Project!)

The project that contains this column.

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.

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

Warning

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

resourcePath (URI!)

The HTTP path for this project column.

Warning

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

updatedAt (DateTime!)

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

Warning

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

url (URI!)

The HTTP URL for this project column.

Warning

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

ProjectColumnConnection

Object

The connection type for ProjectColumn.

Fields for ProjectColumnConnection

NameDescription

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

Object

An edge in a connection.

Fields for ProjectColumnEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (ProjectColumn)

The item at the end of the edge.

ProjectConnection

Object

A list of projects associated with the owner.

Fields for ProjectConnection

NameDescription

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

Object

An edge in a connection.

Fields for ProjectEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Project)

The item at the end of the edge.

ProjectProgress

Object

Project progress stats.

Fields for ProjectProgress

NameDescription

doneCount (Int!)

The number of done cards.

Warning

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

donePercentage (Float!)

The percentage of done cards.

Warning

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

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

Warning

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

inProgressCount (Int!)

The number of in-progress cards.

Warning

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

inProgressPercentage (Float!)

The percentage of in-progress cards.

Warning

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

todoCount (Int!)

The number of to do cards.

Warning

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

todoPercentage (Float!)

The percentage of to do cards.

Warning

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

RemovedFromProjectEvent

Object

Represents aremoved_from_projectevent on a given issue or pull request.

RemovedFromProjectEvent Implements

Fields for RemovedFromProjectEvent

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

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.

Interfaces

ProjectOwner

Interface

Represents an owner of a Project.

ProjectOwner is implemented by

Fields for ProjectOwner

NameDescription

id (ID!)

The Node ID of the ProjectOwner object.

Warning

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

project (Project)

Find project by number.

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.

Arguments for project

  • number (Int!)

    The project number to find.

projects (ProjectConnection!)

A list of projects under the owner.

Warning

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

Arguments for projects

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

projectsResourcePath (URI!)

The HTTP path listing owners projects.

Warning

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

projectsUrl (URI!)

The HTTP URL listing owners projects.

Warning

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

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

Warning

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

Enums

ProjectCardArchivedState

Enum

The possible archived states of a project card.

Values for ProjectCardArchivedState

NameDescription
ARCHIVED

A project card that is archived.

NOT_ARCHIVED

A project card that is not archived.

ProjectCardState

Enum

Various content states of a ProjectCard.

Values for ProjectCardState

NameDescription
CONTENT_ONLY

The card has content only.

NOTE_ONLY

The card has a note only.

REDACTED

The card is redacted.

ProjectColumnPurpose

Enum

The semantic purpose of the column - todo, in progress, or done.

Values for ProjectColumnPurpose

NameDescription
DONE

The column contains cards which are complete.

IN_PROGRESS

The column contains cards which are currently being worked on.

TODO

The column contains cards still to be worked on.

ProjectOrderField

Enum

Properties by which project connections can be ordered.

Values for ProjectOrderField

NameDescription
CREATED_AT

Order projects by creation time.

NAME

Order projects by name.

UPDATED_AT

Order projects by update time.

ProjectState

Enum

State of the project; eitheropenor 'closed'.

Values for ProjectState

NameDescription
CLOSED

The project is closed.

OPEN

The project is open.

ProjectTemplate

Enum

GitHub-provided templates for Projects.

Values for ProjectTemplate

NameDescription
AUTOMATED_KANBAN_V2

Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.

AUTOMATED_REVIEWS_KANBAN

Create a board with triggers to automatically move cards across columns with review automation.

BASIC_KANBAN

Create a board with columns for To do, In progress and Done.

BUG_TRIAGE

Create a board to triage and prioritize bugs with To do, priority, and Done columns.

Unions

ProjectCardItem

Union

Types that can be inside Project Cards.

Possible types for ProjectCardItem

Input objects

AddProjectCardInput

Input object

Autogenerated input type of AddProjectCard.

Input fields for AddProjectCardInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

contentId (ID)

The content of the card. Must be a member of the ProjectCardItem union.

note (String)

The note on the card.

projectColumnId (ID!)

The Node ID of the ProjectColumn.

AddProjectColumnInput

Input object

Autogenerated input type of AddProjectColumn.

Input fields for AddProjectColumnInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of the column.

projectId (ID!)

The Node ID of the project.

CloneProjectInput

Input object

Autogenerated input type of CloneProject.

Input fields for CloneProjectInput

NameDescription

body (String)

The description of the project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

includeWorkflows (Boolean!)

Whether or not to clone the source project's workflows.

name (String!)

The name of the project.

public (Boolean)

The visibility of the project, defaults to false (private).

sourceId (ID!)

The source project to clone.

targetOwnerId (ID!)

The owner ID to create the project under.

ConvertProjectCardNoteToIssueInput

Input object

Autogenerated input type of ConvertProjectCardNoteToIssue.

Input fields for ConvertProjectCardNoteToIssueInput

NameDescription

body (String)

The body of the newly created issue.

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectCardId (ID!)

The ProjectCard ID to convert.

repositoryId (ID!)

The ID of the repository to create the issue in.

title (String)

The title of the newly created issue. Defaults to the card's note text.

CreateProjectInput

Input object

Autogenerated input type of CreateProject.

Input fields for CreateProjectInput

NameDescription

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project.

ownerId (ID!)

The owner ID to create the project under.

repositoryIds ([ID!])

A list of repository IDs to create as linked repositories for the project.

template (ProjectTemplate)

The name of the GitHub-provided template.

DeleteProjectCardInput

Input object

Autogenerated input type of DeleteProjectCard.

Input fields for DeleteProjectCardInput

NameDescription

cardId (ID!)

The id of the card to delete.

clientMutationId (String)

A unique identifier for the client performing the mutation.

DeleteProjectColumnInput

Input object

Autogenerated input type of DeleteProjectColumn.

Input fields for DeleteProjectColumnInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to delete.

DeleteProjectInput

Input object

Autogenerated input type of DeleteProject.

Input fields for DeleteProjectInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The Project ID to update.

LinkRepositoryToProjectInput

Input object

Autogenerated input type of LinkRepositoryToProject.

Input fields for LinkRepositoryToProjectInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project to link to a Repository.

repositoryId (ID!)

The ID of the Repository to link to a Project.

MoveProjectCardInput

Input object

Autogenerated input type of MoveProjectCard.

Input fields for MoveProjectCardInput

NameDescription

afterCardId (ID)

Place the new card after the card with this id. Pass null to place it at the top.

cardId (ID!)

The id of the card to move.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move it into.

MoveProjectColumnInput

Input object

Autogenerated input type of MoveProjectColumn.

Input fields for MoveProjectColumnInput

NameDescription

afterColumnId (ID)

Place the new column after the column with this id. Pass null to place it at the front.

clientMutationId (String)

A unique identifier for the client performing the mutation.

columnId (ID!)

The id of the column to move.

ProjectCardImport

Input object

An issue or PR and its owning repository to be used in a project card.

Input fields for ProjectCardImport

NameDescription

number (Int!)

The issue or pull request number.

repository (String!)

Repository name with owner (owner/repository).

ProjectColumnImport

Input object

A project column and a list of its issues and PRs.

Input fields for ProjectColumnImport

NameDescription

columnName (String!)

The name of the column.

issues ([ProjectCardImport!])

A list of issues and pull requests in the column.

position (Int!)

The position of the column, starting from 0.

ProjectOrder

Input object

Ways in which lists of projects can be ordered upon return.

Input fields for ProjectOrder

NameDescription

direction (OrderDirection!)

The direction in which to order projects by the specified field.

field (ProjectOrderField!)

The field in which to order projects by.

UnlinkRepositoryFromProjectInput

Input object

Autogenerated input type of UnlinkRepositoryFromProject.

Input fields for UnlinkRepositoryFromProjectInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectId (ID!)

The ID of the Project linked to the Repository.

repositoryId (ID!)

The ID of the Repository linked to the Project.

UpdateProjectCardInput

Input object

Autogenerated input type of UpdateProjectCard.

Input fields for UpdateProjectCardInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

isArchived (Boolean)

Whether or not the ProjectCard should be archived.

note (String)

The note of ProjectCard.

projectCardId (ID!)

The ProjectCard ID to update.

UpdateProjectColumnInput

Input object

Autogenerated input type of UpdateProjectColumn.

Input fields for UpdateProjectColumnInput

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String!)

The name of project column.

projectColumnId (ID!)

The ProjectColumn ID to update.

UpdateProjectInput

Input object

Autogenerated input type of UpdateProject.

Input fields for UpdateProjectInput

NameDescription

body (String)

The description of project.

clientMutationId (String)

A unique identifier for the client performing the mutation.

name (String)

The name of project.

projectId (ID!)

The Project ID to update.

public (Boolean)

Whether the project is public or not.

state (ProjectState)

Whether the project is open or closed.