Projects
Download SpecInteract with GitHub Projects.
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.
org
string
required
The organization name. The name is not case sensitive.
state
string
Indicates the state of the projects to return.
- Default
- "open"
- Enum
-
- open
- closed
- all
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
Validation failed, or the endpoint has been spammed.
array[object (Project)]
Project
object (Project)
Projects are a way to organize columns and cards of work.
owner_url
string
uri
required
- Example
- "https://api.github.com/repos/api-playground/projects-test"
url
string
uri
required
- Example
- "https://api.github.com/projects/1002604"
html_url
string
uri
required
- Example
- "https://github.com/api-playground/projects-test/projects/12"
columns_url
string
uri
required
- Example
- "https://api.github.com/projects/1002604/columns"
id
int
required
- Example
- 1002604
node_id
string
required
- Example
- "MDc6UHJvamVjdDEwMDI2MDQ="
name
string
required
Name of the project
- Example
- "Week One Sprint"
body
string or null
required
Body of the project
- Example
- "This project represents the sprint of the first week in January"
number
int
required
- Example
- 1
state
string
required
State of the project; either 'open' or 'closed'
- Example
- "open"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2011-04-10T20:09:31Z"
updated_at
string
date-time
required
- Example
- "2014-03-03T18:58:10Z"
organization_permission
string
The baseline permission that all organization members have on this project. Only present if owner is an organization.
- Enum
-
- read
- write
- admin
- none
private
boolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
Link
string
message
string
required
documentation_url
string
required
errors
array[string]
string
Create an organization project
Creates an organization project board. Returns a 410 Gone
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 401 Unauthorized
or 410 Gone
status is returned.
org
string
required
The organization name. The name is not case sensitive.
name
string
required
The name of the project.
body
string
The description of the project.
Request
Response
Response
Requires authentication
Forbidden
Resource not found
Gone
Validation failed, or the endpoint has been spammed.
owner_url
string
uri
required
- Example
- "https://api.github.com/repos/api-playground/projects-test"
url
string
uri
required
- Example
- "https://api.github.com/projects/1002604"
html_url
string
uri
required
- Example
- "https://github.com/api-playground/projects-test/projects/12"
columns_url
string
uri
required
- Example
- "https://api.github.com/projects/1002604/columns"
id
int
required
- Example
- 1002604
node_id
string
required
- Example
- "MDc6UHJvamVjdDEwMDI2MDQ="
name
string
required
Name of the project
- Example
- "Week One Sprint"
body
string or null
required
Body of the project
- Example
- "This project represents the sprint of the first week in January"
number
int
required
- Example
- 1
state
string
required
State of the project; either 'open' or 'closed'
- Example
- "open"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2011-04-10T20:09:31Z"
updated_at
string
date-time
required
- Example
- "2014-03-03T18:58:10Z"
organization_permission
string
The baseline permission that all organization members have on this project. Only present if owner is an organization.
- Enum
-
- read
- write
- admin
- none
private
boolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
card_id
int
required
The unique identifier of the card.
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
Resource not found
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/cards/1478"
id
int
required
The project card's ID
- Example
- 42
node_id
string
required
- Example
- "MDExOlByb2plY3RDYXJkMTQ3OA=="
note
string or null
required
- Example
- "Add payload for delete Project column"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2016-09-05T14:21:06Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:20:22Z"
archived
boolean
Whether or not the card is archived
- Example
- false
column_name
string
project_id
string
column_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
content_url
string
uri
- Example
- "https://api.github.com/repos/api-playground/projects-test/issues/3"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
card_id
int
required
The unique identifier of the card.
Response
Response
Empty response
Not modified
Empty response
Forbidden
Requires authentication
Resource not found
No schema
No schema
message
string
documentation_url
string
errors
array[string]
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
card_id
int
required
The unique identifier of the card.
note
string or null
The project card's note
- Example
- "Update all gems"
archived
boolean
Whether or not the card is archived
- Example
- false
Request
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
Resource not found
Validation failed, or the endpoint has been spammed.
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/cards/1478"
id
int
required
The project card's ID
- Example
- 42
node_id
string
required
- Example
- "MDExOlByb2plY3RDYXJkMTQ3OA=="
note
string or null
required
- Example
- "Add payload for delete Project column"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2016-09-05T14:21:06Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:20:22Z"
archived
boolean
Whether or not the card is archived
- Example
- false
column_name
string
project_id
string
column_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
content_url
string
uri
- Example
- "https://api.github.com/repos/api-playground/projects-test/issues/3"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
card_id
int
required
The unique identifier of the card.
position
string
^(?:top|bottom|after:\d+)$
required
The position of the card in a column. Can be one of: top
, bottom
, or after:<card_id>
to place after the specified card.
- Example
- "bottom"
column_id
int
The unique identifier of the column the card should be moved to
- Example
- 42
Request
Response
Response
null
Not modified
Empty response
Forbidden
Requires authentication
Response
Validation failed, or the endpoint has been spammed.
No schema
No schema
message
string
documentation_url
string
errors
array[object]
object
code
string
message
string
resource
string
field
string
message
string
documentation_url
string
url
string
status
string
code
string
message
string
documentation_url
string
errors
array[object]
object
code
string
message
string
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
column_id
int
required
The unique identifier of the column.
Response
Response
Not modified
Empty response
Forbidden
Resource not found
Requires authentication
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
cards_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367/cards"
id
int
required
The unique identifier of the project column
- Example
- 42
node_id
string
required
- Example
- "MDEzOlByb2plY3RDb2x1bW4zNjc="
name
string
required
Name of the project column
- Example
- "Remaining tasks"
created_at
string
date-time
required
- Example
- "2016-09-05T14:18:44Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:22:28Z"
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
column_id
int
required
The unique identifier of the column.
Response
Response
Empty response
Not modified
Empty response
Forbidden
Requires authentication
No schema
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
column_id
int
required
The unique identifier of the column.
name
string
required
Name of the project column
- Example
- "Remaining tasks"
Request
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
cards_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367/cards"
id
int
required
The unique identifier of the project column
- Example
- 42
node_id
string
required
- Example
- "MDEzOlByb2plY3RDb2x1bW4zNjc="
name
string
required
Name of the project column
- Example
- "Remaining tasks"
created_at
string
date-time
required
- Example
- "2016-09-05T14:18:44Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:22:28Z"
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
column_id
int
required
The unique identifier of the column.
archived_state
string
Filters the project cards that are returned by the card's state.
- Default
- "not_archived"
- Enum
-
- all
- archived
- not_archived
per_page
int
The number of results per page (max 100).
- Default
- 30
page
int
Page number of the results to fetch.
- Default
- 1
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
array[object (Project Card)]
Project Card
object (Project Card)
Project cards represent a scope of work.
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/cards/1478"
id
int
required
The project card's ID
- Example
- 42
node_id
string
required
- Example
- "MDExOlByb2plY3RDYXJkMTQ3OA=="
note
string or null
required
- Example
- "Add payload for delete Project column"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2016-09-05T14:21:06Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:20:22Z"
archived
boolean
Whether or not the card is archived
- Example
- false
column_name
string
project_id
string
column_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
content_url
string
uri
- Example
- "https://api.github.com/repos/api-playground/projects-test/issues/3"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
Link
string
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
column_id
int
required
The unique identifier of the column.
One Of
object
note
string or null
required
The project card's note
- Example
- "Update all gems"
object
content_id
int
required
The unique identifier of the content associated with the card
- Example
- 42
content_type
string
required
The piece of content associated with the card
- Example
- "PullRequest"
Request
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
Validation failed
Response
url
string
uri
required
- Example
- "https://api.github.com/projects/columns/cards/1478"
id
int
required
The project card's ID
- Example
- 42
node_id
string
required
- Example
- "MDExOlByb2plY3RDYXJkMTQ3OA=="
note
string or null
required
- Example
- "Add payload for delete Project column"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2016-09-05T14:21:06Z"
updated_at
string
date-time
required
- Example
- "2016-09-05T14:20:22Z"
archived
boolean
Whether or not the card is archived
- Example
- false
column_name
string
project_id
string
column_url
string
uri
required
- Example
- "https://api.github.com/projects/columns/367"
content_url
string
uri
- Example
- "https://api.github.com/repos/api-playground/projects-test/issues/3"
project_url
string
uri
required
- Example
- "https://api.github.com/projects/120"
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
One Of
Validation Error
object (Validation Error)
Validation Error
message
string
required
documentation_url
string
required
errors
array[object]
object
resource
string
field
string
message
string
code
string
required
index
int
value
One Of
string or null
int or null
array[string] or null
string
Validation Error Simple
object (Validation Error Simple)
Validation Error Simple
message
string
required
documentation_url
string
required
errors
array[string]
string
code
string
message
string
documentation_url
string
errors
array[object]
object
code
string
message
string
column_id
int
required
The unique identifier of the column.
position
string
^(?:first|last|after:\d+)$
required
The position of the column in a project. Can be one of: first
, last
, or after:<column_id>
to place after the specified column.
- Example
- "last"
Request
Response
Response
null
Not modified
Empty response
Forbidden
Validation failed, or the endpoint has been spammed.
Requires authentication
No schema
No schema
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string
message
string
documentation_url
string
url
string
status
string
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.
project_id
int
required
The unique identifier of the project.
Response
Response
Not modified
Empty response
Forbidden
Requires authentication
owner_url
string
uri
required
- Example
- "https://api.github.com/repos/api-playground/projects-test"
url
string
uri
required
- Example
- "https://api.github.com/projects/1002604"
html_url
string
uri
required
- Example
- "https://github.com/api-playground/projects-test/projects/12"
columns_url
string
uri
required
- Example
- "https://api.github.com/projects/1002604/columns"
id
int
required
- Example
- 1002604
node_id
string
required
- Example
- "MDc6UHJvamVjdDEwMDI2MDQ="
name
string
required
Name of the project
- Example
- "Week One Sprint"
body
string or null
required
Body of the project
- Example
- "This project represents the sprint of the first week in January"
number
int
required
- Example
- 1
state
string
required
State of the project; either 'open' or 'closed'
- Example
- "open"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2011-04-10T20:09:31Z"
updated_at
string
date-time
required
- Example
- "2014-03-03T18:58:10Z"
organization_permission
string
The baseline permission that all organization members have on this project. Only present if owner is an organization.
- Enum
-
- read
- write
- admin
- none
private
boolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
No schema
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
Delete a project
Deletes a project board. Returns a 404 Not Found
status if projects are disabled.
project_id
int
required
The unique identifier of the project.
Response
Delete Success
Empty response
Not modified
Empty response
Forbidden
Requires authentication
Gone
Resource not found
No schema
No schema
message
string
documentation_url
string
errors
array[string]
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
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.
project_id
int
required
The unique identifier of the project.
name
string
Name of the project
- Example
- "Week One Sprint"
body
string or null
Body of the project
- Example
- "This project represents the sprint of the first week in January"
state
string
State of the project; either 'open' or 'closed'
- Example
- "open"
organization_permission
string
The baseline permission that all organization members have on this project
- Enum
-
- read
- write
- admin
- none
private
boolean
Whether or not this project can be seen by everyone.
Request
Response
Response
Not Found if the authenticated user does not have access to the project
Empty response
Not modified
Empty response
Forbidden
Requires authentication
Gone
Validation failed, or the endpoint has been spammed.
owner_url
string
uri
required
- Example
- "https://api.github.com/repos/api-playground/projects-test"
url
string
uri
required
- Example
- "https://api.github.com/projects/1002604"
html_url
string
uri
required
- Example
- "https://github.com/api-playground/projects-test/projects/12"
columns_url
string
uri
required
- Example
- "https://api.github.com/projects/1002604/columns"
id
int
required
- Example
- 1002604
node_id
string
required
- Example
- "MDc6UHJvamVjdDEwMDI2MDQ="
name
string
required
Name of the project
- Example
- "Week One Sprint"
body
string or null
required
Body of the project
- Example
- "This project represents the sprint of the first week in January"
number
int
required
- Example
- 1
state
string
required
State of the project; either 'open' or 'closed'
- Example
- "open"
creator
object (creator) or null
required
A GitHub user.
name
string or null
string or null
login
string
required
- Example
- "octocat"
id
int
required
- Example
- 1
node_id
string
required
- Example
- "MDQ6VXNlcjE="
avatar_url
string
uri
required
- Example
- "https://github.com/images/error/octocat_happy.gif"
gravatar_id
string or null
required
- Example
- "41d064eb2195891e12d0413f63227ea7"
url
string
uri
required
- Example
- "https://api.github.com/users/octocat"
html_url
string
uri
required
- Example
- "https://github.com/octocat"
followers_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/followers"
following_url
string
required
- Example
- "https://api.github.com/users/octocat/following{/other_user}"
gists_url
string
required
- Example
- "https://api.github.com/users/octocat/gists{/gist_id}"
starred_url
string
required
- Example
- "https://api.github.com/users/octocat/starred{/owner}{/repo}"
subscriptions_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/subscriptions"
organizations_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/orgs"
repos_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/repos"
events_url
string
required
- Example
- "https://api.github.com/users/octocat/events{/privacy}"
received_events_url
string
uri
required
- Example
- "https://api.github.com/users/octocat/received_events"
type
string
required
- Example
- "User"
site_admin
boolean
required
starred_at
string
- Example
- "\"2020-07-09T00:17:55Z\""
created_at
string
date-time
required
- Example
- "2011-04-10T20:09:31Z"
updated_at
string
date-time
required
- Example
- "2014-03-03T18:58:10Z"
organization_permission
string
The baseline permission that all organization members have on this project. Only present if owner is an organization.
- Enum
-
- read
- write
- admin
- none
private
boolean
Whether or not this project can be seen by everyone. Only present if owner is an organization.
No schema
No schema
message
string
documentation_url
string
errors
array[string]
string
message
string
documentation_url
string
url
string
status
string
message
string
documentation_url
string
url
string
status
string
message
string
required
documentation_url
string
required
errors
array[string]
string