Project boards

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Help us make these docs great!

Help for wherever you are on your GitHub journey.

Can be one of

Name

All {{ name }} guides

{{ name }} learning paths

Actions

GitHub began rolling these changes out to enterprises on

Enter a search term to find it in the GitHub Docs.

Project boards - GitHub AE Docs

Use the REST API to create, list, update, delete and customize project boards.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

{% data variables.product.prodname_projects_v1_caps %}

Quickstart

About GitHub's APIs

Resources in the REST API

Media types

Authenticating

Keeping API credentials secure

Troubleshooting

Libraries

Issue event types

GitHub event types

Endpoints for GitHub App installation tokens

Endpoints for GitHub App user tokens

Permissions for GitHub Apps

Overview

Using the API

Script with JavaScript

Discover resources for a user

Delivering deployments

Rendering data as graphs

Working with comments

Pagination

Building a CI server

Best practices

Get started - Git database

Get started - Checks

Encrypt secrets

Guides

Artifacts

Permissions

Secrets

Self-hosted runner groups

Self-hosted runners

Workflow jobs

Workflow runs

Workflows

Events

Feeds

Notifications

Starring

Watching

Activity

GitHub Apps

Installations

OAuth Authorizations

Webhooks

Apps

Branches

Protected branches

Check Runs

Check Suites

Checks

Codes of conduct

Code Scanning

Collaborators

Invitations

Commits

Commit comments

Commit statuses

Deploy keys

Deployment branch policies

Deployments

Environments

Deployment statuses

Emojis

Admin stats

Announcement

Audit log

Global Webhooks

License

Organizations

Pre-receive Environments

Users

Enterprise administration

Gists

Comments

Blobs

References

Trees

Git database

Gitignore

Issues

Assignees

Labels

Milestones

Timeline

Licenses

Markdown

Statistics

Metrics

Migrations

Members

Outside Collaborators

Pages

Boards

Cards

Columns

Pulls

Review comments

Review requests

Reviews

Rate limit

Reactions

Releases

Release Assets

Autolinks

Forks

Git LFS

Repositories

Search

Secret scanning

Teams

Discussion comments

Discussions

External groups

Followers

GPG Keys

Git SSH Keys

Repository Webhook Configuration

Repository Webhook Deliveries

Repository Webhooks

Repository webhooks

High-level roadmap for the upcoming year.

Organization Roadmap

Projects are a way to organize columns and cards of work.

Project

Lists the projects in an organization. Returns a <code>404 Not Found</code> status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.

The organization name. The name is not case sensitive.

Indicates the state of the projects to return.

state

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

Validation failed, or the endpoint has been spammed.

List organization projects

name

body

The baseline permission that all organization members have on this project. Only present if owner is an organization.

Whether or not this project can be seen by everyone. Only present if owner is an organization.

State of the project; either 'open' or 'closed'

Creates an organization project board. Returns a <code>410 Gone</code> status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.

Create an organization project

Developer documentation project for the developer site.

Projects Documentation

Gets a project by its <code>id</code>. Returns a <code>404 Not Found</code> status if projects are disabled. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.

The unique identifier of the project.

project_id

Get a project

State of the project; either 'open' or 'closed'

The baseline permission that all organization members have on this project

organization_permission

Whether or not this project can be seen by everyone.

private

Week One Sprint

Change the name, state, and permissions for a project

Updates a project board's information. Returns a <code>404 Not Found</code> status if projects are disabled. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.

Not Found if the authenticated user does not have access to the project

Update a project

Deletes a project board. Returns a <code>404 Not Found</code> status if projects are disabled.

Delete a project

Lists the projects in a repository. Returns a <code>404 Not Found</code> status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

List repository projects