projects

Add project collaborator

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

octokit.projects.addCollaborator({
  project_id,
  username,
});

Parameters

name	required	description
project_id	yes
username	yes
permission	no	The permission to grant the collaborator.

Create a project card

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint.

octokit.projects.createCard({
  column_id,
  note,
  content_id,
  content_type,
});

Parameters

name	required	description
column_id	yes	column_id parameter
note	yes	The project card's note
content_id	yes	The unique identifier of the content associated with the card
content_type	yes	The piece of content associated with the card

Create a project column

octokit.projects.createColumn({
  project_id,
  name,
});

Parameters

name	required	description
project_id	yes
name	yes	Name of the project column

Create a user project

octokit.projects.createForAuthenticatedUser({
  name,
});

Parameters

name	required	description
name	yes	Name of the project
body	no	Body of the project

Create an organization project

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

octokit.projects.createForOrg({
  org,
  name,
});

Parameters

name	required	description
org	yes
name	yes	The name of the project.
body	no	The description of the project.

Create a repository project

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

octokit.projects.createForRepo({
  owner,
  repo,
  name,
});

Parameters

name	required	description
owner	yes
repo	yes
name	yes	The name of the project.
body	no	The description of the project.

Delete a project

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

octokit.projects.delete({
  project_id,
});

Parameters

name	required	description
project_id	yes

Delete a project card

octokit.projects.deleteCard({
  card_id,
});

Parameters

name	required	description
card_id	yes	card_id parameter

Delete a project column

octokit.projects.deleteColumn({
  column_id,
});

Parameters

name	required	description
column_id	yes	column_id parameter

Get a project

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

octokit.projects.get({
  project_id,
});

Parameters

name	required	description
project_id	yes

Get a project card

octokit.projects.getCard({
  card_id,
});

Parameters

name	required	description
card_id	yes	card_id parameter

Get a project column

octokit.projects.getColumn({
  column_id,
});

Parameters

name	required	description
column_id	yes	column_id parameter

Get project permission for a user

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

octokit.projects.getPermissionForUser({
  project_id,
  username,
});

Parameters

name	required	description
project_id	yes
username	yes

List project cards

octokit.projects.listCards({
  column_id,
});

Parameters

name	required	description
column_id	yes	column_id parameter
archived_state	no	Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List project collaborators

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

octokit.projects.listCollaborators({
  project_id,
});

Parameters

name	required	description
project_id	yes
affiliation	no	Filters the collaborators by their affiliation. Can be one of: * `outside`: Outside collaborators of a project that are not a member of the project's organization. * `direct`: Collaborators with permissions to a project, regardless of organization membership status. * `all`: All collaborators the authenticated user can see.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List project columns

octokit.projects.listColumns({
  project_id,
});

Parameters

name	required	description
project_id	yes
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List organization projects

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

octokit.projects.listForOrg({
  org,
});

Parameters

name	required	description
org	yes
state	no	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List repository projects

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

octokit.projects.listForRepo({
  owner,
  repo,
});

Parameters

name	required	description
owner	yes
repo	yes
state	no	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

List user projects

octokit.projects.listForUser({
  username,
});

Parameters

name	required	description
username	yes
state	no	Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.
per_page	no	Results per page (max 100)
page	no	Page number of the results to fetch.

Move a project card

octokit.projects.moveCard({
  card_id,
  position,
});

Parameters

name	required	description
card_id	yes	card_id parameter
position	yes	The position of the card in a column
column_id	no	The unique identifier of the column the card should be moved to

Move a project column

octokit.projects.moveColumn({
  column_id,
  position,
});

Parameters

name	required	description
column_id	yes	column_id parameter
position	yes	The position of the column in a project

Remove user as a collaborator

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

octokit.projects.removeCollaborator({
  project_id,
  username,
});

Parameters

name	required	description
project_id	yes
username	yes

Update a project

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

octokit.projects.update({
  project_id,
});

Parameters

name	required	description
project_id	yes
name	no	Name of the project
body	no	Body of the project
state	no	State of the project; either 'open' or 'closed'
organization_permission	no	The baseline permission that all organization members have on this project
private	no	Whether or not this project can be seen by everyone.

Update an existing project card

octokit.projects.updateCard({
  card_id,
});

Parameters

name	required	description
card_id	yes	card_id parameter
note	no	The project card's note
archived	no	Whether or not the card is archived

Update an existing project column

octokit.projects.updateColumn({
  column_id,
  name,
});

Parameters

name	required	description
column_id	yes	column_id parameter
name	yes	Name of the project column

Octokit Rest API

Add project collaborator

Parameters

Create a project card

Parameters

Create a project column

Parameters

Create a user project

Parameters

Create an organization project

Parameters

Create a repository project

Parameters

Delete a project

Parameters

Delete a project card

Parameters

Delete a project column

Parameters

Get a project

Parameters

Get a project card

Parameters

Get a project column

Parameters

Get project permission for a user

Parameters

List project cards

Parameters

List project collaborators

Parameters

List project columns

Parameters

List organization projects

Parameters

List repository projects

Parameters

List user projects

Parameters

Move a project card

Parameters

Move a project column

Parameters

Remove user as a collaborator

Parameters

Update a project

Parameters

Update an existing project card

Parameters

Update an existing project column

Parameters