← All tags

Projects API Reference

No endpoints match your search.

List projects for organization

GET /orgs/{org}/projectsV2

List all projects owned by a specific organization accessible by the authenticated user.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
q	query	no	Limit results to projects of the specified type.
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Get project for organization

GET /orgs/{org}/projectsV2/{project_number}

Get a specific organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Create draft item for organization owned project

POST /orgs/{org}/projectsV2/{project_number}/drafts

Create draft issue item for the specified organization owned project.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List project fields for organization

GET /orgs/{org}/projectsV2/{project_number}/fields

List all fields for a specific organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Add a field to an organization-owned project.

POST /orgs/{org}/projectsV2/{project_number}/fields

Add a field to an organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response for adding a field to an organization-owned project.	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get project field for organization

GET /orgs/{org}/projectsV2/{project_number}/fields/{field_id}

Get a specific field for an organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
field_id	path	yes	The unique identifier of the field.
org	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List items for an organization owned project

GET /orgs/{org}/projectsV2/{project_number}/items

List all items for a specific organization-owned project accessible by the authenticated user.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
q	query	no	Search query to filter items, see Filtering projects for more information.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Add item to organization owned project

POST /orgs/{org}/projectsV2/{project_number}/items

Add an issue or pull request item to the specified organization owned project.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Get an item for an organization owned project

GET /orgs/{org}/projectsV2/{project_number}/items/{item_id}

Get a specific item from an organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
item_id	path	yes	The unique identifier of the project item.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Update project item for organization

PATCH /orgs/{org}/projectsV2/{project_number}/items/{item_id}

Update a specific item in an organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
item_id	path	yes	The unique identifier of the project item.

Responses

Status	Description	Has JSON body
200	Response	yes
401	Requires authentication	yes
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Delete project item for organization

DELETE /orgs/{org}/projectsV2/{project_number}/items/{item_id}

Delete a specific item from an organization-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
item_id	path	yes	The unique identifier of the project item.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
401	Requires authentication	yes

Create a view for an organization-owned project

POST /orgs/{org}/projectsV2/{project_number}/views

Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response for creating a view in an organization-owned project.	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

List items for an organization project view

GET /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items

List items in an organization project with the saved view's filter applied.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
org	path	yes	The organization name. The name is not case sensitive.
view_number	path	yes	The number that identifies the project view.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
404	Resource not found	yes

Create draft item for user owned project

POST /user/{user_id}/projectsV2/{project_number}/drafts

Create draft issue item for the specified user owned project.

Parameters

Name	In	Required	Description
user_id	path	yes	The unique identifier of the user.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Create a view for a user-owned project

POST /users/{user_id}/projectsV2/{project_number}/views

Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered.

Parameters

Name	In	Required	Description
user_id	path	yes	The unique identifier of the user.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response for creating a view in a user-owned project.	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes
503	Service unavailable	yes

List projects for user

GET /users/{username}/projectsV2

List all projects owned by a specific user accessible by the authenticated user.

Parameters

Name	In	Required	Description
username	path	yes	The handle for the GitHub user account.
q	query	no	Limit results to projects of the specified type.
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Get project for user

GET /users/{username}/projectsV2/{project_number}

Get a specific user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List project fields for user

GET /users/{username}/projectsV2/{project_number}/fields

List all fields for a specific user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Add field to user owned project

POST /users/{username}/projectsV2/{project_number}/fields

Add a field to a specified user owned project.

Parameters

Name	In	Required	Description
username	path	yes	The handle for the GitHub user account.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get project field for user

GET /users/{username}/projectsV2/{project_number}/fields/{field_id}

Get a specific field for a user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
field_id	path	yes	The unique identifier of the field.
username	path	yes	The handle for the GitHub user account.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

List items for a user owned project

GET /users/{username}/projectsV2/{project_number}/items

List all items for a specific user-owned project accessible by the authenticated user.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
q	query	no	Search query to filter items, see Filtering projects for more information.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Add item to user owned project

POST /users/{username}/projectsV2/{project_number}/items

Add an issue or pull request item to the specified user owned project.

Parameters

Name	In	Required	Description
username	path	yes	The handle for the GitHub user account.
project_number	path	yes	The project's number.

Responses

Status	Description	Has JSON body
201	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Get an item for a user owned project

GET /users/{username}/projectsV2/{project_number}/items/{item_id}

Get a specific item from a user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
item_id	path	yes	The unique identifier of the project item.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the title field will be returned.

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes

Update project item for user

PATCH /users/{username}/projectsV2/{project_number}/items/{item_id}

Update a specific item in a user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
item_id	path	yes	The unique identifier of the project item.

Responses

Status	Description	Has JSON body
200	Response	yes
401	Requires authentication	yes
403	Forbidden	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Delete project item for user

DELETE /users/{username}/projectsV2/{project_number}/items/{item_id}

Delete a specific item from a user-owned project.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
item_id	path	yes	The unique identifier of the project item.

Responses

Status	Description	Has JSON body
204	Response	no
403	Forbidden	yes
401	Requires authentication	yes

List items for a user project view

GET /users/{username}/projectsV2/{project_number}/views/{view_number}/items

List items in a user project with the saved view's filter applied.

Parameters

Name	In	Required	Description
project_number	path	yes	The project's number.
username	path	yes	The handle for the GitHub user account.
view_number	path	yes	The number that identifies the project view.
fields	query	no	Limit results to specific fields, by their IDs. If not specified, the
before	query	no	A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
after	query	no	A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
304	Not modified	no
403	Forbidden	yes
401	Requires authentication	yes
404	Resource not found	yes