Projects

Endpoints to manage Projects using the REST API.

Operations

MethodEndpointDescription
GET/orgs/{org}/projectsV2List projects for organization
GET/orgs/{org}/projectsV2/{project_number}Get project for organization
POST/orgs/{org}/projectsV2/{project_number}/draftsCreate draft item for organization owned project
GET/orgs/{org}/projectsV2/{project_number}/fieldsList project fields for organization
POST/orgs/{org}/projectsV2/{project_number}/fieldsAdd a field to an organization-owned project.
GET/orgs/{org}/projectsV2/{project_number}/fields/{field_id}Get project field for organization
GET/orgs/{org}/projectsV2/{project_number}/itemsList items for an organization owned project
POST/orgs/{org}/projectsV2/{project_number}/itemsAdd item to organization owned project
GET/orgs/{org}/projectsV2/{project_number}/items/{item_id}Get an item for an organization owned project
PATCH/orgs/{org}/projectsV2/{project_number}/items/{item_id}Update project item for organization
DELETE/orgs/{org}/projectsV2/{project_number}/items/{item_id}Delete project item for organization
POST/orgs/{org}/projectsV2/{project_number}/viewsCreate a view for an organization-owned project
GET/orgs/{org}/projectsV2/{project_number}/views/{view_number}/itemsList items for an organization project view
POST/user/{user_id}/projectsV2/{project_number}/draftsCreate draft item for user owned project
POST/users/{user_id}/projectsV2/{project_number}/viewsCreate a view for a user-owned project
GET/users/{username}/projectsV2List projects for user
GET/users/{username}/projectsV2/{project_number}Get project for user
GET/users/{username}/projectsV2/{project_number}/fieldsList project fields for user
POST/users/{username}/projectsV2/{project_number}/fieldsAdd field to user owned project
GET/users/{username}/projectsV2/{project_number}/fields/{field_id}Get project field for user
GET/users/{username}/projectsV2/{project_number}/itemsList items for a user owned project
POST/users/{username}/projectsV2/{project_number}/itemsAdd item to user owned project
GET/users/{username}/projectsV2/{project_number}/items/{item_id}Get an item for a user owned project
PATCH/users/{username}/projectsV2/{project_number}/items/{item_id}Update project item for user
DELETE/users/{username}/projectsV2/{project_number}/items/{item_id}Delete project item for user
GET/users/{username}/projectsV2/{project_number}/views/{view_number}/itemsList items for a user project view

Example

List projects for organization, with the TypeScript SDK:

ts
import { GitHubV3REST } from "github";

const client = new GitHubV3REST({
  baseUrl: "https://api.github.com",
});

const result = await client.projects.listForOrg({
  org: "org",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.