Projects

Reference documentation for GraphQL schema types in the Projects category.

In this article

Mutations

addProjectV2DraftIssue

Mutation

Creates a new draft issue and add it to a Project.

Input fields for addProjectV2DraftIssue

Return fields for addProjectV2DraftIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectItem (ProjectV2Item)

The draft issue added to the project.

addProjectV2ItemById

Mutation

Links an existing content instance to a Project.

Input fields for addProjectV2ItemById

Return fields for addProjectV2ItemById

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item added to the project.

archiveProjectV2Item

Mutation

Archives a ProjectV2Item.

Input fields for archiveProjectV2Item

Return fields for archiveProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item archived from the project.

clearProjectV2ItemFieldValue

Mutation

This mutation clears the value of a field for an item in a Project. Currently only text, number, date, assignees, labels, single-select, multi-select, iteration and milestone fields are supported.

Input fields for clearProjectV2ItemFieldValue

Return fields for clearProjectV2ItemFieldValue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

convertProjectV2DraftIssueItemToIssue

Mutation

Converts a projectV2 draft issue item to an issue.

Input fields for convertProjectV2DraftIssueItemToIssue

Return fields for convertProjectV2DraftIssueItemToIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The updated project item.

copyProjectV2

Mutation

Copy a project.

Input fields for copyProjectV2

Return fields for copyProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The copied project.

createProjectV2

Mutation

Creates a new project.

Input fields for createProjectV2

Return fields for createProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The new project.

createProjectV2Field

Mutation

Create a new project field.

Input fields for createProjectV2Field

Return fields for createProjectV2Field

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createProjectV2IssueField

Mutation

Create a new project issue field.

Input fields for createProjectV2IssueField

Return fields for createProjectV2IssueField

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The new field.

createProjectV2StatusUpdate

Mutation

Creates a status update within a Project.

Input fields for createProjectV2StatusUpdate

Return fields for createProjectV2StatusUpdate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdate (ProjectV2StatusUpdate)

The status update updated in the project.

createProjectV2View

Mutation

Creates a new view in a project.

Input fields for createProjectV2View

Return fields for createProjectV2View

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2View (ProjectV2View)

The new view.

deleteProjectV2

Mutation

Delete a project.

Input fields for deleteProjectV2

Return fields for deleteProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The deleted Project.

deleteProjectV2Field

Mutation

Delete a project field.

Input fields for deleteProjectV2Field

Return fields for deleteProjectV2Field

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The deleted field.

deleteProjectV2Item

Mutation

Deletes an item from a Project.

Input fields for deleteProjectV2Item

Return fields for deleteProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedItemId (ID)

The ID of the deleted item.

deleteProjectV2StatusUpdate

Mutation

Deletes a project status update.

Input fields for deleteProjectV2StatusUpdate

Return fields for deleteProjectV2StatusUpdate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedStatusUpdateId (ID)

The ID of the deleted status update.

projectV2 (ProjectV2)

The project the deleted status update was in.

deleteProjectV2View

Mutation

Deletes a view from a project.

Input fields for deleteProjectV2View

Return fields for deleteProjectV2View

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2View (ProjectV2View)

The deleted view.

deleteProjectV2Workflow

Mutation

Deletes a project workflow.

Input fields for deleteProjectV2Workflow

Return fields for deleteProjectV2Workflow

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

deletedWorkflowId (ID)

The ID of the deleted workflow.

projectV2 (ProjectV2)

The project the deleted workflow was in.

linkProjectV2ToRepository

Mutation

Links a project to a repository.

Input fields for linkProjectV2ToRepository

Return fields for linkProjectV2ToRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is linked to.

linkProjectV2ToTeam

Mutation

Links a project to a team.

Input fields for linkProjectV2ToTeam

Return fields for linkProjectV2ToTeam

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is linked to.

markProjectV2AsTemplate

Mutation

Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.

Input fields for markProjectV2AsTemplate

Return fields for markProjectV2AsTemplate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

unarchiveProjectV2Item

Mutation

Unarchives a ProjectV2Item.

Input fields for unarchiveProjectV2Item

Return fields for unarchiveProjectV2Item

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

item (ProjectV2Item)

The item unarchived from the project.

unlinkProjectV2FromRepository

Mutation

Unlinks a project from a repository.

Input fields for unlinkProjectV2FromRepository

Return fields for unlinkProjectV2FromRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

repository (Repository)

The repository the project is no longer linked to.

unlinkProjectV2FromTeam

Mutation

Unlinks a project to a team.

Input fields for unlinkProjectV2FromTeam

Return fields for unlinkProjectV2FromTeam

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

team (Team)

The team the project is unlinked from.

unmarkProjectV2AsTemplate

Mutation

Unmark a project as a template.

Input fields for unmarkProjectV2AsTemplate

Return fields for unmarkProjectV2AsTemplate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The project.

updateProjectV2

Mutation

Updates an existing project.

Input fields for updateProjectV2

Return fields for updateProjectV2

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2 (ProjectV2)

The updated Project.

updateProjectV2Collaborators

Mutation

Update the collaborators on a team or a project.

Input fields for updateProjectV2Collaborators

Return fields for updateProjectV2Collaborators

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

collaborators (ProjectV2ActorConnection)

The collaborators granted a role.

updateProjectV2DraftIssue

Mutation

Updates a draft issue within a Project.

Input fields for updateProjectV2DraftIssue

Return fields for updateProjectV2DraftIssue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

draftIssue (DraftIssue)

The draft issue updated in the project.

updateProjectV2Field

Mutation

Update a project field.

Input fields for updateProjectV2Field

Return fields for updateProjectV2Field

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Field (ProjectV2FieldConfiguration)

The updated field.

updateProjectV2ItemFieldValue

Mutation

This mutation updates the value of a field for an item in a Project. Currently only single-select, multi-select, text, number, date, and iteration fields are supported.

Input fields for updateProjectV2ItemFieldValue

Return fields for updateProjectV2ItemFieldValue

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2Item (ProjectV2Item)

The updated item.

updateProjectV2ItemPosition

Mutation

This mutation updates the position of the item in the project, where the position represents the priority of an item.

Input fields for updateProjectV2ItemPosition

Return fields for updateProjectV2ItemPosition

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

items (ProjectV2ItemConnection)

The items in the new order.

updateProjectV2StatusUpdate

Mutation

Updates a status update within a Project.

Input fields for updateProjectV2StatusUpdate

Return fields for updateProjectV2StatusUpdate

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

statusUpdate (ProjectV2StatusUpdate)

The status update updated in the project.

updateProjectV2View

Mutation

Updates an existing view in a project.

Input fields for updateProjectV2View

Return fields for updateProjectV2View

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

projectV2View (ProjectV2View)

The updated view.

Objects

AddedToProjectV2Event

Object

Represents aadded_to_project_v2event on a given issue or pull request.

AddedToProjectV2Event Implements

Fields for AddedToProjectV2Event

NameDescription

actor (Actor)

Identifies the actor who performed the event.

createdAt (DateTime!)

Identifies the date and time when the object was created.

id (ID!)

The Node ID of the AddedToProjectV2Event object.

project (ProjectV2)

Project referenced by event.

wasAutomated (Boolean!)

Did this event result from workflow automation?.

DraftIssue

Object

A draft issue within a project.

DraftIssue Implements

Fields for DraftIssue

NameDescription

assignees (UserConnection!)

A list of users to assigned to this draft issue.

Arguments for assignees

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

body (String!)

The body of the draft issue.

bodyHTML (HTML!)

The body of the draft issue rendered to HTML.

bodyText (String!)

The body of the draft issue rendered to text.

createdAt (DateTime!)

Identifies the date and time when the object was created.

creator (Actor)

The actor who created this draft issue.

id (ID!)

The Node ID of the DraftIssue object.

projectV2Items (ProjectV2ItemConnection!)

List of items linked with the draft issue (currently draft issue can be linked to only one item).

Arguments for projectV2Items

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

projectsV2 (ProjectV2Connection!)

Projects that link to this draft issue (currently draft issue can be linked to only one project).

Arguments for projectsV2

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

title (String!)

The title of the draft issue.

updatedAt (DateTime!)

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

ProjectV2

Object

New projects that manage issues, pull requests and drafts using tables and boards.

ProjectV2 Implements

Fields for ProjectV2

NameDescription

closed (Boolean!)

Returns true if the project is closed.

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)

The actor who originally created the project.

databaseId (Int)

Identifies the primary key from the database.

Warning

databaseId is deprecated.

databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.

field (ProjectV2FieldConfiguration)

A field of the project.

Arguments for field

  • name (String!)

    The name of the field.

fields (ProjectV2FieldConfigurationConnection!)

List of fields and their constraints in the project.

Arguments for fields

  • 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 (ProjectV2FieldOrder)

    Ordering options for project v2 fields returned from the connection.

fullDatabaseId (BigInt)

Identifies the primary key from the database as a BigInt.

id (ID!)

The Node ID of the ProjectV2 object.

items (ProjectV2ItemConnection!)

List of items in the project.

Arguments for items

  • 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 (ProjectV2ItemOrder)

    Ordering options for project v2 items returned from the connection.

  • query (String)

    Search query for filtering items.

    The default value is .

number (Int!)

The project's number.

owner (ProjectV2Owner!)

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

public (Boolean!)

Returns true if the project is public.

readme (String)

The project's readme.

repositories (RepositoryConnection!)

The repositories the project is linked to.

Arguments for repositories

  • 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 (RepositoryOrder)

    Ordering options for repositories returned from the connection.

resourcePath (URI!)

The HTTP path for this project.

shortDescription (String)

The project's short description.

statusUpdates (ProjectV2StatusUpdateConnection!)

List of the status updates in the project.

Arguments for statusUpdates

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

teams (TeamConnection!)

The teams the project is linked to.

Arguments for teams

  • 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 (TeamOrder)

    Ordering options for teams returned from this connection.

template (Boolean!)

Returns true if this project is a template.

title (String!)

The project's name.

updatedAt (DateTime!)

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

url (URI!)

The HTTP URL for this project.

view (ProjectV2View)

A view of the project.

Arguments for view

  • number (Int!)

    The number of a view belonging to the project.

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.

views (ProjectV2ViewConnection!)

List of views in the project.

Arguments for views

  • 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 (ProjectV2ViewOrder)

    Ordering options for project v2 views returned from the connection.

workflow (ProjectV2Workflow)

A workflow of the project.

Arguments for workflow

  • number (Int!)

    The number of a workflow belonging to the project.

workflows (ProjectV2WorkflowConnection!)

List of the workflows in the project.

Arguments for workflows

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

ProjectV2ActorConnection

Object

The connection type for ProjectV2Actor.

Fields for ProjectV2ActorConnection

NameDescription

edges ([ProjectV2ActorEdge])

A list of edges.

nodes ([ProjectV2Actor])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

ProjectV2ActorEdge

Object

An edge in a connection.

Fields for ProjectV2ActorEdge

NameDescription

cursor (String!)