GitHub v3 REST API

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.

get
{protocol}://{hostname}/api/v3/orgs/{org}/projects

Query Parameters

statestring

Indicates the state of the projects to return. Can be either open, closed, or all.

Allowed values:openclosedall

Default:open

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

orgstringrequired

Response

application/json

Response

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

owner_urlstring(uri)required

Example:https://api.github.com/repos/api-playground/projects-test

urlstring(uri)required

Example:https://api.github.com/projects/1002604

html_urlstring(uri)required

Example:https://github.com/api-playground/projects-test/projects/12

columns_urlstring(uri)required

Example:https://api.github.com/projects/1002604/columns

idintegerrequired

Example:1002604

node_idstringrequired

Example:MDc6UHJvamVjdDEwMDI2MDQ=

namestringrequired

Name of the project

Example:Week One Sprint

bodystring | nullrequired

Body of the project

Example:This project represents the sprint of the first week in January

numberintegerrequired

Example:1

statestringrequired

State of the project; either ‘open’ or ‘closed’

Example:open

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-10T20:09:31Z

updated_atstring(date-time)required

Example:2014-03-03T18:58:10Z

organization_permissionstring

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

Allowed values:readwriteadminnone

privateboolean

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

get/orgs/{org}/projects
 
application/json

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.

post
{protocol}://{hostname}/api/v3/orgs/{org}/projects

Path Parameters

orgstringrequired

Body

application/json
namestringrequired

The name of the project.

bodystring

The description of the project.

Response

application/json

Response

Project

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

owner_urlstring(uri)required

Example:https://api.github.com/repos/api-playground/projects-test

urlstring(uri)required

Example:https://api.github.com/projects/1002604

html_urlstring(uri)required

Example:https://github.com/api-playground/projects-test/projects/12

columns_urlstring(uri)required

Example:https://api.github.com/projects/1002604/columns

idintegerrequired

Example:1002604

node_idstringrequired

Example:MDc6UHJvamVjdDEwMDI2MDQ=

namestringrequired

Name of the project

Example:Week One Sprint

bodystring | nullrequired

Body of the project

Example:This project represents the sprint of the first week in January

numberintegerrequired

Example:1

statestringrequired

State of the project; either ‘open’ or ‘closed’

Example:open

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-10T20:09:31Z

updated_atstring(date-time)required

Example:2014-03-03T18:58:10Z

organization_permissionstring

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

Allowed values:readwriteadminnone

privateboolean

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

post/orgs/{org}/projects

Body

{ "name": "Organization Roadmap", "body": "High-level roadmap for the upcoming year." }
 
application/json

Get a project card

get
{protocol}://{hostname}/api/v3/projects/columns/cards/{card_id}

Path Parameters

card_idintegerrequired

card_id parameter

Response

application/json

Response

Project Card

Project cards represent a scope of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/cards/1478

idintegerrequired

The project card’s ID

Example:42

node_idstringrequired

Example:MDExOlByb2plY3RDYXJkMTQ3OA==

notestring | nullrequired

Example:Add payload for delete Project column

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2016-09-05T14:21:06Z

updated_atstring(date-time)required

Example:2016-09-05T14:20:22Z

archivedboolean

Whether or not the card is archived

Example:false

column_namestring
project_idstring
column_urlstring(uri)required

Example:https://api.github.com/projects/columns/367

content_urlstring(uri)

Example:https://api.github.com/repos/api-playground/projects-test/issues/3

project_urlstring(uri)required

Example:https://api.github.com/projects/120

get/projects/columns/cards/{card_id}
 
application/json

Update an existing project card

patch
{protocol}://{hostname}/api/v3/projects/columns/cards/{card_id}

Path Parameters

card_idintegerrequired

card_id parameter

Body

application/json
notestring | null

The project card’s note

Example:Update all gems

archivedboolean

Whether or not the card is archived

Example:false

Response

application/json

Response

Project Card

Project cards represent a scope of work.

urlstring(uri)required

Example:https://api.github.com/projects/columns/cards/1478

idintegerrequired

The project card’s ID

Example:42

node_idstringrequired

Example:MDExOlByb2plY3RDYXJkMTQ3OA==

notestring | nullrequired

Example:Add payload for delete Project column

creatorobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2016-09-05T14:21:06Z

updated_atstring(date-time)required

Example:2016-09-05T14:20:22Z

archivedboolean

Whether or not the card is archived

Example:false

column_namestring
project_idstring
column_urlstring(uri)required

Example:https://api.github.com/projects/columns/367

content_urlstring(uri)

Example:https://api.github.com/repos/api-playground/projects-test/issues/3

project_urlstring(uri)required

Example:https://api.github.com/projects/120

patch/projects/columns/cards/{card_id}

Body

{}
 
application/json

Delete a project card

delete
{protocol}://{hostname}/api/v3/projects/columns/cards/{card_id}

Path Parameters

card_idintegerrequired

card_id parameter

Response

Response

delete/projects/columns/cards/{card_id}