Use the REST API to manage Project items
Note
Most endpoints use Authorization: Bearer <YOUR-TOKEN> and Accept: application/vnd.github+json headers, plus X-GitHub-Api-Version: 2026-03-10. Curl examples below omit these standard headers for brevity.
GET /orgs/{org}/projectsV2/{project_number}/items
List all items for a specific organization-owned project accessible by the authenticated user.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
org (string) (required)
The organization name. The name is not case sensitive.
q (string)
Search query to filter items, see Filtering projects for more information.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
before (string)
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 (string)
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 (integer)
The number of results per page (max 100). For more information, see "Using pagination in the REST API."
Default: 30
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X GET \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items
Response schema (Status: 200):
Array of Projects v2 Item:
id: required, numbernode_id: stringproject_url: string, format: uricontent_type: required, string, enum: Issue, PullRequest, DraftIssuecontent: object or null, additional properties allowedcreator: Simple User:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeitem_url: string or null, format: urifields: array of object, additional properties allowedPOST /orgs/{org}/projectsV2/{project_number}/items
Add an issue or pull request item to the specified organization owned project.
accept (string)application/vnd.github+json is recommended.org (string) (required)
The organization name. The name is not case sensitive.
project_number (integer) (required)
The project's number.
type (string) (required)
The type of item to add to the project. Must be either Issue or PullRequest.
Can be one of: Issue, PullRequest
id (integer)
The unique identifier of the issue or pull request to add to the project.
owner (string)
The repository owner login.
repo (string)
The repository name.
number (integer)
The issue or pull request number.
201 - Created
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X POST \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "Issue",
"id": 3
}'
Response schema (Status: 201):
id: required, numbernode_id: stringcontent: one of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: urirepository_url: required, string, format: urilabels_url: required, stringcomments_url: required, string, format: urievents_url: required, string, format: urihtml_url: required, string, format: urinumber: required, integerstate: required, stringstate_reason: string or null, enum: completed, reopened, not_planned, duplicate, nulltitle: required, stringbody: string or nulluser: required, any of:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringlabels: required, array of items:
id: integer, format: int64node_id: stringurl: string, format: uriname: stringdescription: string or nullcolor: string or nulldefault: booleanarchived_by: all of:
assignees: array of Simple User (see above)milestone: required, any of:
url: required, string, format: urihtml_url: required, string, format: urilabels_url: required, string, format: uriid: required, integernode_id: required, stringnumber: required, integerstate: required, string, enum: open, closed, default: "open"title: required, stringdescription: required, string or nullcreator: required, any of:
open_issues: required, integerclosed_issues: required, integercreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timedue_on: required, string or null, format: date-timelocked: required, booleanactive_lock_reason: string or nullcomments: required, integerpull_request: object:
merged_at: string or null, format: date-timediff_url: required, string or null, format: urihtml_url: required, string or null, format: uripatch_url: required, string or null, format: uriurl: required, string or null, format: uriclosed_at: required, string or null, format: date-timecreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timedraft: booleanclosed_by: any of:
body_html: stringbody_text: stringtimeline_url: string, format: uritype: Issue Type:
id: required, integernode_id: required, stringname: required, stringdescription: required, string or nullcolor: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, nullcreated_at: string, format: date-timeupdated_at: string, format: date-timeis_enabled: booleanrepository: Repository:
id: required, integer, format: int64node_id: required, stringname: required, stringfull_name: required, stringlicense: required, any of:
key: required, stringname: required, stringurl: required, string or null, format: urispdx_id: required, string or nullnode_id: required, stringhtml_url: string, format: uriforks: required, integerpermissions: object:
admin: required, booleanpull: required, booleantriage: booleanpush: required, booleanmaintain: booleanowner: required, Simple User (see above)private: required, boolean, default: falsehtml_url: required, string, format: uridescription: required, string or nullfork: required, booleanurl: required, string, format: uriarchive_url: required, stringassignees_url: required, stringblobs_url: required, stringbranches_url: required, stringcollaborators_url: required, stringcomments_url: required, stringcommits_url: required, stringcompare_url: required, stringcontents_url: required, stringcontributors_url: required, string, format: urideployments_url: required, string, format: uridownloads_url: required, string, format: urievents_url: required, string, format: uriforks_url: required, string, format: urigit_commits_url: required, stringgit_refs_url: required, stringgit_tags_url: required, stringgit_url: required, stringissue_comment_url: required, stringissue_events_url: required, stringissues_url: required, stringkeys_url: required, stringlabels_url: required, stringlanguages_url: required, string, format: urimerges_url: required, string, format: urimilestones_url: required, stringnotifications_url: required, stringpulls_url: required, stringreleases_url: required, stringssh_url: required, stringstargazers_url: required, string, format: uristatuses_url: required, stringsubscribers_url: required, string, format: urisubscription_url: required, string, format: uritags_url: required, string, format: uriteams_url: required, string, format: uritrees_url: required, stringclone_url: required, stringmirror_url: required, string or null, format: urihooks_url: required, string, format: urisvn_url: required, string, format: urihomepage: required, string or null, format: urilanguage: required, string or nullforks_count: required, integerstargazers_count: required, integerwatchers_count: required, integersize: required, integerdefault_branch: required, stringopen_issues_count: required, integeris_template: boolean, default: falsetopics: array of stringhas_issues: required, boolean, default: truehas_projects: required, boolean, default: truehas_wiki: required, boolean, default: truehas_pages: required, booleanhas_discussions: boolean, default: falsehas_pull_requests: boolean, default: truepull_request_creation_policy: string, enum: all, collaborators_onlyarchived: required, boolean, default: falsedisabled: required, booleanvisibility: string, default: "public"pushed_at: required, string or null, format: date-timecreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeallow_rebase_merge: boolean, default: truetemp_clone_token: stringallow_squash_merge: boolean, default: trueallow_auto_merge: boolean, default: falsedelete_branch_on_merge: boolean, default: falseallow_update_branch: boolean, default: falsesquash_merge_commit_title: string, enum: PR_TITLE, COMMIT_OR_PR_TITLEsquash_merge_commit_message: string, enum: PR_BODY, COMMIT_MESSAGES, BLANKmerge_commit_title: string, enum: PR_TITLE, MERGE_MESSAGEmerge_commit_message: string, enum: PR_BODY, PR_TITLE, BLANKallow_merge_commit: boolean, default: trueallow_forking: booleanweb_commit_signoff_required: boolean, default: falseopen_issues: required, integerwatchers: required, integerstarred_at: stringanonymous_access_enabled: booleancode_search_index_status: object:
lexical_search_ok: booleanlexical_commit_sha: stringperformed_via_github_app: any of:
id: required, integerslug: stringnode_id: required, stringclient_id: stringowner: required, one of:
description: string or nullhtml_url: required, string, format: uriwebsite_url: string or null, format: uriid: required, integernode_id: required, stringname: required, stringslug: required, stringcreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeavatar_url: required, string, format: uriname: required, stringdescription: required, string or nullexternal_url: required, string, format: urihtml_url: required, string, format: uricreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timepermissions: required, object, additional properties: string:
issues: stringchecks: stringmetadata: stringcontents: stringdeployments: stringevents: required, array of stringinstallations_count: integerauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERreactions: Reaction Rollup:
url: required, string, format: uritotal_count: required, integer+1: required, integer-1: required, integerlaugh: required, integerconfused: required, integerheart: required, integerhooray: required, integereyes: required, integerrocket: required, integersub_issues_summary: Sub-issues Summary:
total: required, integercompleted: required, integerpercent_completed: required, integerparent_issue_url: string or null, format: uripinned_comment: any of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: uribody: stringbody_text: stringbody_html: stringhtml_url: required, string, format: uriuser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timeissue_url: required, string, format: uriauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERperformed_via_github_app: any of:
reactions: Reaction Rollup (see above)pin: any of:
pinned_at: required, string, format: date-timepinned_by: required, any of:
minimized: any of:
reason: required, string or nullissue_dependencies_summary: Issue Dependencies Summary:
blocked_by: required, integerblocking: required, integertotal_blocked_by: required, integertotal_blocking: required, integerissue_field_values: array of Issue Field Value:
issue_field_id: required, integer, format: int64issue_field_name: stringnode_id: required, stringdata_type: required, string, enum: text, single_select, multi_select, number, datevalue: required, any of:
single_select_option: object or null:
id: required, integer, format: int64name: required, stringcolor: required, stringmulti_select_options: array of objects or null:
id: required, integer, format: int64name: required, stringcolor: required, stringurl: required, string, format: uriid: required, integer, format: int64node_id: required, stringhtml_url: required, string, format: uridiff_url: required, string, format: uripatch_url: required, string, format: uriissue_url: required, string, format: uricommits_url: required, string, format: urireview_comments_url: required, string, format: urireview_comment_url: required, stringcomments_url: required, string, format: uristatuses_url: required, string, format: urinumber: required, integerstate: required, stringlocked: required, booleantitle: required, stringuser: required, any of:
body: required, string or nulllabels: required, array of objects:
id: required, integer, format: int64node_id: required, stringurl: required, stringname: required, stringdescription: required, stringcolor: required, stringdefault: required, booleanarchived_by: required, all of:
milestone: required, any of:
active_lock_reason: string or nullcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timemerged_at: required, string or null, format: date-timeassignees: array of Simple User (see above)requested_reviewers: array of Simple User (see above)requested_teams: array of Team:
id: required, integernode_id: required, stringname: required, stringslug: required, stringdescription: required, string or nullprivacy: stringnotification_setting: stringpermission: required, stringpermissions: object:
pull: required, booleantriage: required, booleanpush: required, booleanmaintain: required, booleanadmin: required, booleanurl: required, string, format: urihtml_url: required, string, format: urimembers_url: required, stringrepositories_url: required, string, format: uritype: required, string, enum: enterprise, organizationaccess_source: string, enum: direct, organization, enterpriseorganization_id: integerenterprise_id: integerparent: required, any of:
id: required, integernode_id: required, stringurl: required, string, format: urimembers_url: required, stringname: required, stringdescription: required, string or nullpermission: required, stringprivacy: stringnotification_setting: stringhtml_url: required, string, format: urirepositories_url: required, string, format: urislug: required, stringldap_dn: stringtype: required, string, enum: enterprise, organizationorganization_id: integerenterprise_id: integerhead: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
base: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
_links: required, object:
comments: required, Link:
href: required, stringcommits: required, Link (see above)statuses: required, Link (see above)html: required, Link (see above)issue: required, Link (see above)review_comments: required, Link (see above)review_comment: required, Link (see above)self: required, Link (see above)author_association: required, string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERauto_merge: required, Auto merge:
enabled_by: required, Simple User (see above)merge_method: required, string, enum: merge, squash, rebasecommit_title: required, stringcommit_message: required, stringstack: Pull Request Stack:
base: required, object:
ref: required, stringsha: required, stringsize: integerposition: integerid: integernumber: integerdraft: booleanid: required, numbernode_id: required, stringtitle: required, stringbody: string or nulluser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timecontent_type: required, string, enum: Issue, PullRequest, DraftIssuecreator: Simple User (see above)created_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeproject_url: string, format: uriitem_url: string, format: uriRequest:
curl -L \
-X POST \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "PullRequest",
"id": 3
}'
Response schema (Status: 201):
id: required, numbernode_id: stringcontent: one of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: urirepository_url: required, string, format: urilabels_url: required, stringcomments_url: required, string, format: urievents_url: required, string, format: urihtml_url: required, string, format: urinumber: required, integerstate: required, stringstate_reason: string or null, enum: completed, reopened, not_planned, duplicate, nulltitle: required, stringbody: string or nulluser: required, any of:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringlabels: required, array of items:
id: integer, format: int64node_id: stringurl: string, format: uriname: stringdescription: string or nullcolor: string or nulldefault: booleanarchived_by: all of:
assignees: array of Simple User (see above)milestone: required, any of:
url: required, string, format: urihtml_url: required, string, format: urilabels_url: required, string, format: uriid: required, integernode_id: required, stringnumber: required, integerstate: required, string, enum: open, closed, default: "open"title: required, stringdescription: required, string or nullcreator: required, any of:
open_issues: required, integerclosed_issues: required, integercreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timedue_on: required, string or null, format: date-timelocked: required, booleanactive_lock_reason: string or nullcomments: required, integerpull_request: object:
merged_at: string or null, format: date-timediff_url: required, string or null, format: urihtml_url: required, string or null, format: uripatch_url: required, string or null, format: uriurl: required, string or null, format: uriclosed_at: required, string or null, format: date-timecreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timedraft: booleanclosed_by: any of:
body_html: stringbody_text: stringtimeline_url: string, format: uritype: Issue Type:
id: required, integernode_id: required, stringname: required, stringdescription: required, string or nullcolor: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, nullcreated_at: string, format: date-timeupdated_at: string, format: date-timeis_enabled: booleanrepository: Repository:
id: required, integer, format: int64node_id: required, stringname: required, stringfull_name: required, stringlicense: required, any of:
key: required, stringname: required, stringurl: required, string or null, format: urispdx_id: required, string or nullnode_id: required, stringhtml_url: string, format: uriforks: required, integerpermissions: object:
admin: required, booleanpull: required, booleantriage: booleanpush: required, booleanmaintain: booleanowner: required, Simple User (see above)private: required, boolean, default: falsehtml_url: required, string, format: uridescription: required, string or nullfork: required, booleanurl: required, string, format: uriarchive_url: required, stringassignees_url: required, stringblobs_url: required, stringbranches_url: required, stringcollaborators_url: required, stringcomments_url: required, stringcommits_url: required, stringcompare_url: required, stringcontents_url: required, stringcontributors_url: required, string, format: urideployments_url: required, string, format: uridownloads_url: required, string, format: urievents_url: required, string, format: uriforks_url: required, string, format: urigit_commits_url: required, stringgit_refs_url: required, stringgit_tags_url: required, stringgit_url: required, stringissue_comment_url: required, stringissue_events_url: required, stringissues_url: required, stringkeys_url: required, stringlabels_url: required, stringlanguages_url: required, string, format: urimerges_url: required, string, format: urimilestones_url: required, stringnotifications_url: required, stringpulls_url: required, stringreleases_url: required, stringssh_url: required, stringstargazers_url: required, string, format: uristatuses_url: required, stringsubscribers_url: required, string, format: urisubscription_url: required, string, format: uritags_url: required, string, format: uriteams_url: required, string, format: uritrees_url: required, stringclone_url: required, stringmirror_url: required, string or null, format: urihooks_url: required, string, format: urisvn_url: required, string, format: urihomepage: required, string or null, format: urilanguage: required, string or nullforks_count: required, integerstargazers_count: required, integerwatchers_count: required, integersize: required, integerdefault_branch: required, stringopen_issues_count: required, integeris_template: boolean, default: falsetopics: array of stringhas_issues: required, boolean, default: truehas_projects: required, boolean, default: truehas_wiki: required, boolean, default: truehas_pages: required, booleanhas_discussions: boolean, default: falsehas_pull_requests: boolean, default: truepull_request_creation_policy: string, enum: all, collaborators_onlyarchived: required, boolean, default: falsedisabled: required, booleanvisibility: string, default: "public"pushed_at: required, string or null, format: date-timecreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeallow_rebase_merge: boolean, default: truetemp_clone_token: stringallow_squash_merge: boolean, default: trueallow_auto_merge: boolean, default: falsedelete_branch_on_merge: boolean, default: falseallow_update_branch: boolean, default: falsesquash_merge_commit_title: string, enum: PR_TITLE, COMMIT_OR_PR_TITLEsquash_merge_commit_message: string, enum: PR_BODY, COMMIT_MESSAGES, BLANKmerge_commit_title: string, enum: PR_TITLE, MERGE_MESSAGEmerge_commit_message: string, enum: PR_BODY, PR_TITLE, BLANKallow_merge_commit: boolean, default: trueallow_forking: booleanweb_commit_signoff_required: boolean, default: falseopen_issues: required, integerwatchers: required, integerstarred_at: stringanonymous_access_enabled: booleancode_search_index_status: object:
lexical_search_ok: booleanlexical_commit_sha: stringperformed_via_github_app: any of:
id: required, integerslug: stringnode_id: required, stringclient_id: stringowner: required, one of:
description: string or nullhtml_url: required, string, format: uriwebsite_url: string or null, format: uriid: required, integernode_id: required, stringname: required, stringslug: required, stringcreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeavatar_url: required, string, format: uriname: required, stringdescription: required, string or nullexternal_url: required, string, format: urihtml_url: required, string, format: uricreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timepermissions: required, object, additional properties: string:
issues: stringchecks: stringmetadata: stringcontents: stringdeployments: stringevents: required, array of stringinstallations_count: integerauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERreactions: Reaction Rollup:
url: required, string, format: uritotal_count: required, integer+1: required, integer-1: required, integerlaugh: required, integerconfused: required, integerheart: required, integerhooray: required, integereyes: required, integerrocket: required, integersub_issues_summary: Sub-issues Summary:
total: required, integercompleted: required, integerpercent_completed: required, integerparent_issue_url: string or null, format: uripinned_comment: any of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: uribody: stringbody_text: stringbody_html: stringhtml_url: required, string, format: uriuser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timeissue_url: required, string, format: uriauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERperformed_via_github_app: any of:
reactions: Reaction Rollup (see above)pin: any of:
pinned_at: required, string, format: date-timepinned_by: required, any of:
minimized: any of:
reason: required, string or nullissue_dependencies_summary: Issue Dependencies Summary:
blocked_by: required, integerblocking: required, integertotal_blocked_by: required, integertotal_blocking: required, integerissue_field_values: array of Issue Field Value:
issue_field_id: required, integer, format: int64issue_field_name: stringnode_id: required, stringdata_type: required, string, enum: text, single_select, multi_select, number, datevalue: required, any of:
single_select_option: object or null:
id: required, integer, format: int64name: required, stringcolor: required, stringmulti_select_options: array of objects or null:
id: required, integer, format: int64name: required, stringcolor: required, stringurl: required, string, format: uriid: required, integer, format: int64node_id: required, stringhtml_url: required, string, format: uridiff_url: required, string, format: uripatch_url: required, string, format: uriissue_url: required, string, format: uricommits_url: required, string, format: urireview_comments_url: required, string, format: urireview_comment_url: required, stringcomments_url: required, string, format: uristatuses_url: required, string, format: urinumber: required, integerstate: required, stringlocked: required, booleantitle: required, stringuser: required, any of:
body: required, string or nulllabels: required, array of objects:
id: required, integer, format: int64node_id: required, stringurl: required, stringname: required, stringdescription: required, stringcolor: required, stringdefault: required, booleanarchived_by: required, all of:
milestone: required, any of:
active_lock_reason: string or nullcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timemerged_at: required, string or null, format: date-timeassignees: array of Simple User (see above)requested_reviewers: array of Simple User (see above)requested_teams: array of Team:
id: required, integernode_id: required, stringname: required, stringslug: required, stringdescription: required, string or nullprivacy: stringnotification_setting: stringpermission: required, stringpermissions: object:
pull: required, booleantriage: required, booleanpush: required, booleanmaintain: required, booleanadmin: required, booleanurl: required, string, format: urihtml_url: required, string, format: urimembers_url: required, stringrepositories_url: required, string, format: uritype: required, string, enum: enterprise, organizationaccess_source: string, enum: direct, organization, enterpriseorganization_id: integerenterprise_id: integerparent: required, any of:
id: required, integernode_id: required, stringurl: required, string, format: urimembers_url: required, stringname: required, stringdescription: required, string or nullpermission: required, stringprivacy: stringnotification_setting: stringhtml_url: required, string, format: urirepositories_url: required, string, format: urislug: required, stringldap_dn: stringtype: required, string, enum: enterprise, organizationorganization_id: integerenterprise_id: integerhead: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
base: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
_links: required, object:
comments: required, Link:
href: required, stringcommits: required, Link (see above)statuses: required, Link (see above)html: required, Link (see above)issue: required, Link (see above)review_comments: required, Link (see above)review_comment: required, Link (see above)self: required, Link (see above)author_association: required, string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERauto_merge: required, Auto merge:
enabled_by: required, Simple User (see above)merge_method: required, string, enum: merge, squash, rebasecommit_title: required, stringcommit_message: required, stringstack: Pull Request Stack:
base: required, object:
ref: required, stringsha: required, stringsize: integerposition: integerid: integernumber: integerdraft: booleanid: required, numbernode_id: required, stringtitle: required, stringbody: string or nulluser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timecontent_type: required, string, enum: Issue, PullRequest, DraftIssuecreator: Simple User (see above)created_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeproject_url: string, format: uriitem_url: string, format: uriRequest:
curl -L \
-X POST \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "Issue",
"owner": "octocat",
"repo": "hello-world",
"number": 42
}'
Response schema (Status: 201):
id: required, numbernode_id: stringcontent: one of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: urirepository_url: required, string, format: urilabels_url: required, stringcomments_url: required, string, format: urievents_url: required, string, format: urihtml_url: required, string, format: urinumber: required, integerstate: required, stringstate_reason: string or null, enum: completed, reopened, not_planned, duplicate, nulltitle: required, stringbody: string or nulluser: required, any of:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringlabels: required, array of items:
id: integer, format: int64node_id: stringurl: string, format: uriname: stringdescription: string or nullcolor: string or nulldefault: booleanarchived_by: all of:
assignees: array of Simple User (see above)milestone: required, any of:
url: required, string, format: urihtml_url: required, string, format: urilabels_url: required, string, format: uriid: required, integernode_id: required, stringnumber: required, integerstate: required, string, enum: open, closed, default: "open"title: required, stringdescription: required, string or nullcreator: required, any of:
open_issues: required, integerclosed_issues: required, integercreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timedue_on: required, string or null, format: date-timelocked: required, booleanactive_lock_reason: string or nullcomments: required, integerpull_request: object:
merged_at: string or null, format: date-timediff_url: required, string or null, format: urihtml_url: required, string or null, format: uripatch_url: required, string or null, format: uriurl: required, string or null, format: uriclosed_at: required, string or null, format: date-timecreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timedraft: booleanclosed_by: any of:
body_html: stringbody_text: stringtimeline_url: string, format: uritype: Issue Type:
id: required, integernode_id: required, stringname: required, stringdescription: required, string or nullcolor: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, nullcreated_at: string, format: date-timeupdated_at: string, format: date-timeis_enabled: booleanrepository: Repository:
id: required, integer, format: int64node_id: required, stringname: required, stringfull_name: required, stringlicense: required, any of:
key: required, stringname: required, stringurl: required, string or null, format: urispdx_id: required, string or nullnode_id: required, stringhtml_url: string, format: uriforks: required, integerpermissions: object:
admin: required, booleanpull: required, booleantriage: booleanpush: required, booleanmaintain: booleanowner: required, Simple User (see above)private: required, boolean, default: falsehtml_url: required, string, format: uridescription: required, string or nullfork: required, booleanurl: required, string, format: uriarchive_url: required, stringassignees_url: required, stringblobs_url: required, stringbranches_url: required, stringcollaborators_url: required, stringcomments_url: required, stringcommits_url: required, stringcompare_url: required, stringcontents_url: required, stringcontributors_url: required, string, format: urideployments_url: required, string, format: uridownloads_url: required, string, format: urievents_url: required, string, format: uriforks_url: required, string, format: urigit_commits_url: required, stringgit_refs_url: required, stringgit_tags_url: required, stringgit_url: required, stringissue_comment_url: required, stringissue_events_url: required, stringissues_url: required, stringkeys_url: required, stringlabels_url: required, stringlanguages_url: required, string, format: urimerges_url: required, string, format: urimilestones_url: required, stringnotifications_url: required, stringpulls_url: required, stringreleases_url: required, stringssh_url: required, stringstargazers_url: required, string, format: uristatuses_url: required, stringsubscribers_url: required, string, format: urisubscription_url: required, string, format: uritags_url: required, string, format: uriteams_url: required, string, format: uritrees_url: required, stringclone_url: required, stringmirror_url: required, string or null, format: urihooks_url: required, string, format: urisvn_url: required, string, format: urihomepage: required, string or null, format: urilanguage: required, string or nullforks_count: required, integerstargazers_count: required, integerwatchers_count: required, integersize: required, integerdefault_branch: required, stringopen_issues_count: required, integeris_template: boolean, default: falsetopics: array of stringhas_issues: required, boolean, default: truehas_projects: required, boolean, default: truehas_wiki: required, boolean, default: truehas_pages: required, booleanhas_discussions: boolean, default: falsehas_pull_requests: boolean, default: truepull_request_creation_policy: string, enum: all, collaborators_onlyarchived: required, boolean, default: falsedisabled: required, booleanvisibility: string, default: "public"pushed_at: required, string or null, format: date-timecreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeallow_rebase_merge: boolean, default: truetemp_clone_token: stringallow_squash_merge: boolean, default: trueallow_auto_merge: boolean, default: falsedelete_branch_on_merge: boolean, default: falseallow_update_branch: boolean, default: falsesquash_merge_commit_title: string, enum: PR_TITLE, COMMIT_OR_PR_TITLEsquash_merge_commit_message: string, enum: PR_BODY, COMMIT_MESSAGES, BLANKmerge_commit_title: string, enum: PR_TITLE, MERGE_MESSAGEmerge_commit_message: string, enum: PR_BODY, PR_TITLE, BLANKallow_merge_commit: boolean, default: trueallow_forking: booleanweb_commit_signoff_required: boolean, default: falseopen_issues: required, integerwatchers: required, integerstarred_at: stringanonymous_access_enabled: booleancode_search_index_status: object:
lexical_search_ok: booleanlexical_commit_sha: stringperformed_via_github_app: any of:
id: required, integerslug: stringnode_id: required, stringclient_id: stringowner: required, one of:
description: string or nullhtml_url: required, string, format: uriwebsite_url: string or null, format: uriid: required, integernode_id: required, stringname: required, stringslug: required, stringcreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeavatar_url: required, string, format: uriname: required, stringdescription: required, string or nullexternal_url: required, string, format: urihtml_url: required, string, format: uricreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timepermissions: required, object, additional properties: string:
issues: stringchecks: stringmetadata: stringcontents: stringdeployments: stringevents: required, array of stringinstallations_count: integerauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERreactions: Reaction Rollup:
url: required, string, format: uritotal_count: required, integer+1: required, integer-1: required, integerlaugh: required, integerconfused: required, integerheart: required, integerhooray: required, integereyes: required, integerrocket: required, integersub_issues_summary: Sub-issues Summary:
total: required, integercompleted: required, integerpercent_completed: required, integerparent_issue_url: string or null, format: uripinned_comment: any of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: uribody: stringbody_text: stringbody_html: stringhtml_url: required, string, format: uriuser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timeissue_url: required, string, format: uriauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERperformed_via_github_app: any of:
reactions: Reaction Rollup (see above)pin: any of:
pinned_at: required, string, format: date-timepinned_by: required, any of:
minimized: any of:
reason: required, string or nullissue_dependencies_summary: Issue Dependencies Summary:
blocked_by: required, integerblocking: required, integertotal_blocked_by: required, integertotal_blocking: required, integerissue_field_values: array of Issue Field Value:
issue_field_id: required, integer, format: int64issue_field_name: stringnode_id: required, stringdata_type: required, string, enum: text, single_select, multi_select, number, datevalue: required, any of:
single_select_option: object or null:
id: required, integer, format: int64name: required, stringcolor: required, stringmulti_select_options: array of objects or null:
id: required, integer, format: int64name: required, stringcolor: required, stringurl: required, string, format: uriid: required, integer, format: int64node_id: required, stringhtml_url: required, string, format: uridiff_url: required, string, format: uripatch_url: required, string, format: uriissue_url: required, string, format: uricommits_url: required, string, format: urireview_comments_url: required, string, format: urireview_comment_url: required, stringcomments_url: required, string, format: uristatuses_url: required, string, format: urinumber: required, integerstate: required, stringlocked: required, booleantitle: required, stringuser: required, any of:
body: required, string or nulllabels: required, array of objects:
id: required, integer, format: int64node_id: required, stringurl: required, stringname: required, stringdescription: required, stringcolor: required, stringdefault: required, booleanarchived_by: required, all of:
milestone: required, any of:
active_lock_reason: string or nullcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timemerged_at: required, string or null, format: date-timeassignees: array of Simple User (see above)requested_reviewers: array of Simple User (see above)requested_teams: array of Team:
id: required, integernode_id: required, stringname: required, stringslug: required, stringdescription: required, string or nullprivacy: stringnotification_setting: stringpermission: required, stringpermissions: object:
pull: required, booleantriage: required, booleanpush: required, booleanmaintain: required, booleanadmin: required, booleanurl: required, string, format: urihtml_url: required, string, format: urimembers_url: required, stringrepositories_url: required, string, format: uritype: required, string, enum: enterprise, organizationaccess_source: string, enum: direct, organization, enterpriseorganization_id: integerenterprise_id: integerparent: required, any of:
id: required, integernode_id: required, stringurl: required, string, format: urimembers_url: required, stringname: required, stringdescription: required, string or nullpermission: required, stringprivacy: stringnotification_setting: stringhtml_url: required, string, format: urirepositories_url: required, string, format: urislug: required, stringldap_dn: stringtype: required, string, enum: enterprise, organizationorganization_id: integerenterprise_id: integerhead: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
base: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
_links: required, object:
comments: required, Link:
href: required, stringcommits: required, Link (see above)statuses: required, Link (see above)html: required, Link (see above)issue: required, Link (see above)review_comments: required, Link (see above)review_comment: required, Link (see above)self: required, Link (see above)author_association: required, string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERauto_merge: required, Auto merge:
enabled_by: required, Simple User (see above)merge_method: required, string, enum: merge, squash, rebasecommit_title: required, stringcommit_message: required, stringstack: Pull Request Stack:
base: required, object:
ref: required, stringsha: required, stringsize: integerposition: integerid: integernumber: integerdraft: booleanid: required, numbernode_id: required, stringtitle: required, stringbody: string or nulluser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timecontent_type: required, string, enum: Issue, PullRequest, DraftIssuecreator: Simple User (see above)created_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeproject_url: string, format: uriitem_url: string, format: uriRequest:
curl -L \
-X POST \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "PullRequest",
"owner": "octocat",
"repo": "hello-world",
"number": 123
}'
Response schema (Status: 201):
id: required, numbernode_id: stringcontent: one of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: urirepository_url: required, string, format: urilabels_url: required, stringcomments_url: required, string, format: urievents_url: required, string, format: urihtml_url: required, string, format: urinumber: required, integerstate: required, stringstate_reason: string or null, enum: completed, reopened, not_planned, duplicate, nulltitle: required, stringbody: string or nulluser: required, any of:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringlabels: required, array of items:
id: integer, format: int64node_id: stringurl: string, format: uriname: stringdescription: string or nullcolor: string or nulldefault: booleanarchived_by: all of:
assignees: array of Simple User (see above)milestone: required, any of:
url: required, string, format: urihtml_url: required, string, format: urilabels_url: required, string, format: uriid: required, integernode_id: required, stringnumber: required, integerstate: required, string, enum: open, closed, default: "open"title: required, stringdescription: required, string or nullcreator: required, any of:
open_issues: required, integerclosed_issues: required, integercreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timedue_on: required, string or null, format: date-timelocked: required, booleanactive_lock_reason: string or nullcomments: required, integerpull_request: object:
merged_at: string or null, format: date-timediff_url: required, string or null, format: urihtml_url: required, string or null, format: uripatch_url: required, string or null, format: uriurl: required, string or null, format: uriclosed_at: required, string or null, format: date-timecreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timedraft: booleanclosed_by: any of:
body_html: stringbody_text: stringtimeline_url: string, format: uritype: Issue Type:
id: required, integernode_id: required, stringname: required, stringdescription: required, string or nullcolor: string or null, enum: gray, blue, green, yellow, orange, red, pink, purple, nullcreated_at: string, format: date-timeupdated_at: string, format: date-timeis_enabled: booleanrepository: Repository:
id: required, integer, format: int64node_id: required, stringname: required, stringfull_name: required, stringlicense: required, any of:
key: required, stringname: required, stringurl: required, string or null, format: urispdx_id: required, string or nullnode_id: required, stringhtml_url: string, format: uriforks: required, integerpermissions: object:
admin: required, booleanpull: required, booleantriage: booleanpush: required, booleanmaintain: booleanowner: required, Simple User (see above)private: required, boolean, default: falsehtml_url: required, string, format: uridescription: required, string or nullfork: required, booleanurl: required, string, format: uriarchive_url: required, stringassignees_url: required, stringblobs_url: required, stringbranches_url: required, stringcollaborators_url: required, stringcomments_url: required, stringcommits_url: required, stringcompare_url: required, stringcontents_url: required, stringcontributors_url: required, string, format: urideployments_url: required, string, format: uridownloads_url: required, string, format: urievents_url: required, string, format: uriforks_url: required, string, format: urigit_commits_url: required, stringgit_refs_url: required, stringgit_tags_url: required, stringgit_url: required, stringissue_comment_url: required, stringissue_events_url: required, stringissues_url: required, stringkeys_url: required, stringlabels_url: required, stringlanguages_url: required, string, format: urimerges_url: required, string, format: urimilestones_url: required, stringnotifications_url: required, stringpulls_url: required, stringreleases_url: required, stringssh_url: required, stringstargazers_url: required, string, format: uristatuses_url: required, stringsubscribers_url: required, string, format: urisubscription_url: required, string, format: uritags_url: required, string, format: uriteams_url: required, string, format: uritrees_url: required, stringclone_url: required, stringmirror_url: required, string or null, format: urihooks_url: required, string, format: urisvn_url: required, string, format: urihomepage: required, string or null, format: urilanguage: required, string or nullforks_count: required, integerstargazers_count: required, integerwatchers_count: required, integersize: required, integerdefault_branch: required, stringopen_issues_count: required, integeris_template: boolean, default: falsetopics: array of stringhas_issues: required, boolean, default: truehas_projects: required, boolean, default: truehas_wiki: required, boolean, default: truehas_pages: required, booleanhas_discussions: boolean, default: falsehas_pull_requests: boolean, default: truepull_request_creation_policy: string, enum: all, collaborators_onlyarchived: required, boolean, default: falsedisabled: required, booleanvisibility: string, default: "public"pushed_at: required, string or null, format: date-timecreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeallow_rebase_merge: boolean, default: truetemp_clone_token: stringallow_squash_merge: boolean, default: trueallow_auto_merge: boolean, default: falsedelete_branch_on_merge: boolean, default: falseallow_update_branch: boolean, default: falsesquash_merge_commit_title: string, enum: PR_TITLE, COMMIT_OR_PR_TITLEsquash_merge_commit_message: string, enum: PR_BODY, COMMIT_MESSAGES, BLANKmerge_commit_title: string, enum: PR_TITLE, MERGE_MESSAGEmerge_commit_message: string, enum: PR_BODY, PR_TITLE, BLANKallow_merge_commit: boolean, default: trueallow_forking: booleanweb_commit_signoff_required: boolean, default: falseopen_issues: required, integerwatchers: required, integerstarred_at: stringanonymous_access_enabled: booleancode_search_index_status: object:
lexical_search_ok: booleanlexical_commit_sha: stringperformed_via_github_app: any of:
id: required, integerslug: stringnode_id: required, stringclient_id: stringowner: required, one of:
description: string or nullhtml_url: required, string, format: uriwebsite_url: string or null, format: uriid: required, integernode_id: required, stringname: required, stringslug: required, stringcreated_at: required, string or null, format: date-timeupdated_at: required, string or null, format: date-timeavatar_url: required, string, format: uriname: required, stringdescription: required, string or nullexternal_url: required, string, format: urihtml_url: required, string, format: uricreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timepermissions: required, object, additional properties: string:
issues: stringchecks: stringmetadata: stringcontents: stringdeployments: stringevents: required, array of stringinstallations_count: integerauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERreactions: Reaction Rollup:
url: required, string, format: uritotal_count: required, integer+1: required, integer-1: required, integerlaugh: required, integerconfused: required, integerheart: required, integerhooray: required, integereyes: required, integerrocket: required, integersub_issues_summary: Sub-issues Summary:
total: required, integercompleted: required, integerpercent_completed: required, integerparent_issue_url: string or null, format: uripinned_comment: any of:
id: required, integer, format: int64node_id: required, stringurl: required, string, format: uribody: stringbody_text: stringbody_html: stringhtml_url: required, string, format: uriuser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timeissue_url: required, string, format: uriauthor_association: string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERperformed_via_github_app: any of:
reactions: Reaction Rollup (see above)pin: any of:
pinned_at: required, string, format: date-timepinned_by: required, any of:
minimized: any of:
reason: required, string or nullissue_dependencies_summary: Issue Dependencies Summary:
blocked_by: required, integerblocking: required, integertotal_blocked_by: required, integertotal_blocking: required, integerissue_field_values: array of Issue Field Value:
issue_field_id: required, integer, format: int64issue_field_name: stringnode_id: required, stringdata_type: required, string, enum: text, single_select, multi_select, number, datevalue: required, any of:
single_select_option: object or null:
id: required, integer, format: int64name: required, stringcolor: required, stringmulti_select_options: array of objects or null:
id: required, integer, format: int64name: required, stringcolor: required, stringurl: required, string, format: uriid: required, integer, format: int64node_id: required, stringhtml_url: required, string, format: uridiff_url: required, string, format: uripatch_url: required, string, format: uriissue_url: required, string, format: uricommits_url: required, string, format: urireview_comments_url: required, string, format: urireview_comment_url: required, stringcomments_url: required, string, format: uristatuses_url: required, string, format: urinumber: required, integerstate: required, stringlocked: required, booleantitle: required, stringuser: required, any of:
body: required, string or nulllabels: required, array of objects:
id: required, integer, format: int64node_id: required, stringurl: required, stringname: required, stringdescription: required, stringcolor: required, stringdefault: required, booleanarchived_by: required, all of:
milestone: required, any of:
active_lock_reason: string or nullcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timeclosed_at: required, string or null, format: date-timemerged_at: required, string or null, format: date-timeassignees: array of Simple User (see above)requested_reviewers: array of Simple User (see above)requested_teams: array of Team:
id: required, integernode_id: required, stringname: required, stringslug: required, stringdescription: required, string or nullprivacy: stringnotification_setting: stringpermission: required, stringpermissions: object:
pull: required, booleantriage: required, booleanpush: required, booleanmaintain: required, booleanadmin: required, booleanurl: required, string, format: urihtml_url: required, string, format: urimembers_url: required, stringrepositories_url: required, string, format: uritype: required, string, enum: enterprise, organizationaccess_source: string, enum: direct, organization, enterpriseorganization_id: integerenterprise_id: integerparent: required, any of:
id: required, integernode_id: required, stringurl: required, string, format: urimembers_url: required, stringname: required, stringdescription: required, string or nullpermission: required, stringprivacy: stringnotification_setting: stringhtml_url: required, string, format: urirepositories_url: required, string, format: urislug: required, stringldap_dn: stringtype: required, string, enum: enterprise, organizationorganization_id: integerenterprise_id: integerhead: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
base: required, object:
label: required, stringref: required, stringrepo: required, Repository (see above)sha: required, stringuser: required, any of:
_links: required, object:
comments: required, Link:
href: required, stringcommits: required, Link (see above)statuses: required, Link (see above)html: required, Link (see above)issue: required, Link (see above)review_comments: required, Link (see above)review_comment: required, Link (see above)self: required, Link (see above)author_association: required, string, enum: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERauto_merge: required, Auto merge:
enabled_by: required, Simple User (see above)merge_method: required, string, enum: merge, squash, rebasecommit_title: required, stringcommit_message: required, stringstack: Pull Request Stack:
base: required, object:
ref: required, stringsha: required, stringsize: integerposition: integerid: integernumber: integerdraft: booleanid: required, numbernode_id: required, stringtitle: required, stringbody: string or nulluser: required, any of:
created_at: required, string, format: date-timeupdated_at: required, string, format: date-timecontent_type: required, string, enum: Issue, PullRequest, DraftIssuecreator: Simple User (see above)created_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeproject_url: string, format: uriitem_url: string, format: uriGET /orgs/{org}/projectsV2/{project_number}/items/{item_id}
Get a specific item from an organization-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
org (string) (required)
The organization name. The name is not case sensitive.
item_id (integer) (required)
The unique identifier of the project item.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X GET \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID
Response schema (Status: 200):
id: required, numbernode_id: stringproject_url: string, format: uricontent_type: required, string, enum: Issue, PullRequest, DraftIssuecontent: object or null, additional properties allowedcreator: Simple User:
name: string or nullemail: string or nulllogin: required, stringid: required, integer, format: int64node_id: required, stringavatar_url: required, string, format: urigravatar_id: required, string or nullurl: required, string, format: urihtml_url: required, string, format: urifollowers_url: required, string, format: urifollowing_url: required, stringgists_url: required, stringstarred_url: required, stringsubscriptions_url: required, string, format: uriorganizations_url: required, string, format: urirepos_url: required, string, format: urievents_url: required, stringreceived_events_url: required, string, format: uritype: required, stringsite_admin: required, booleanstarred_at: stringuser_view_type: stringcreated_at: required, string, format: date-timeupdated_at: required, string, format: date-timearchived_at: required, string or null, format: date-timeitem_url: string or null, format: urifields: array of object, additional properties allowedPATCH /orgs/{org}/projectsV2/{project_number}/items/{item_id}
Update a specific item in an organization-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
org (string) (required)
The organization name. The name is not case sensitive.
item_id (integer) (required)
The unique identifier of the project item.
fields (array of objects) (required)id (integer) (required)
The ID of the project field to update.
value (null or string or number) (required)
The new value for the field:
For text, number, and date fields, provide the new value directly.
For single select and iteration fields, provide the ID of the option or iteration.
To clear the field, set this to null.
200 - OK
401 - Requires authentication
403 - Forbidden
404 - Resource not found
422 - Validation failed, or the endpoint has been spammed.
Request:
curl -L \
-X PATCH \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 123,
"value": "Updated text value"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 456,
"value": 42.5
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 789,
"value": "2023-10-05"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 789,
"value": "47fc9ee4"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 1011,
"value": "866ee5b8"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
DELETE /orgs/{org}/projectsV2/{project_number}/items/{item_id}
Delete a specific item from an organization-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
org (string) (required)
The organization name. The name is not case sensitive.
item_id (integer) (required)
The unique identifier of the project item.
204 - No Content
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X DELETE \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID
Response schema (Status: 204):
GET /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items
List items in an organization project with the saved view's filter applied.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
org (string) (required)
The organization name. The name is not case sensitive.
view_number (integer) (required)
The number that identifies the project view.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the
title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
before (string)
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 (string)
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 (integer)
The number of results per page (max 100). For more information, see "Using pagination in the REST API."
Default: 30
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
404 - Resource not found
Request:
curl -L \
-X GET \
https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/views/VIEW_NUMBER/items
Response schema (Status: 200):
Same response schema as List items for an organization owned project.
GET /users/{username}/projectsV2/{project_number}/items
List all items for a specific user-owned project accessible by the authenticated user.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
username (string) (required)
The handle for the GitHub user account.
before (string)
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 (string)
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 (integer)
The number of results per page (max 100). For more information, see "Using pagination in the REST API."
Default: 30
q (string)
Search query to filter items, see Filtering projects for more information.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X GET \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items
Response schema (Status: 200):
Same response schema as List items for an organization owned project.
POST /users/{username}/projectsV2/{project_number}/items
Add an issue or pull request item to the specified user owned project.
accept (string)application/vnd.github+json is recommended.username (string) (required)
The handle for the GitHub user account.
project_number (integer) (required)
The project's number.
type (string) (required)
The type of item to add to the project. Must be either Issue or PullRequest.
Can be one of: Issue, PullRequest
id (integer)
The unique identifier of the issue or pull request to add to the project.
owner (string)
The repository owner login.
repo (string)
The repository name.
number (integer)
The issue or pull request number.
201 - Created
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X POST \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "Issue",
"id": 3
}'
Response schema (Status: 201):
Same response schema as Add item to organization owned project.
Request:
curl -L \
-X POST \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "PullRequest",
"id": 3
}'
Response schema (Status: 201):
Same response schema as Add item to organization owned project.
Request:
curl -L \
-X POST \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "Issue",
"owner": "octocat",
"repo": "hello-world",
"number": 42
}'
Response schema (Status: 201):
Same response schema as Add item to organization owned project.
Request:
curl -L \
-X POST \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \
-d '{
"type": "PullRequest",
"owner": "octocat",
"repo": "hello-world",
"number": 123
}'
Response schema (Status: 201):
Same response schema as Add item to organization owned project.
GET /users/{username}/projectsV2/{project_number}/items/{item_id}
Get a specific item from a user-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
username (string) (required)
The handle for the GitHub user account.
item_id (integer) (required)
The unique identifier of the project item.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X GET \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
PATCH /users/{username}/projectsV2/{project_number}/items/{item_id}
Update a specific item in a user-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
username (string) (required)
The handle for the GitHub user account.
item_id (integer) (required)
The unique identifier of the project item.
fields (array of objects) (required)id (integer) (required)
The ID of the project field to update.
value (null or string or number) (required)
The new value for the field:
For text, number, and date fields, provide the new value directly.
For single select and iteration fields, provide the ID of the option or iteration.
To clear the field, set this to null.
200 - OK
401 - Requires authentication
403 - Forbidden
404 - Resource not found
422 - Validation failed, or the endpoint has been spammed.
Request:
curl -L \
-X PATCH \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 123,
"value": "Updated text value"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 456,
"value": 42.5
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 789,
"value": "2023-10-05"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 789,
"value": "47fc9ee4"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
Request:
curl -L \
-X PATCH \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \
-d '{
"fields": [
{
"id": 1011,
"value": "866ee5b8"
}
]
}'
Response schema (Status: 200):
Same response schema as Get an item for an organization owned project.
DELETE /users/{username}/projectsV2/{project_number}/items/{item_id}
Delete a specific item from a user-owned project.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
username (string) (required)
The handle for the GitHub user account.
item_id (integer) (required)
The unique identifier of the project item.
204 - No Content
401 - Requires authentication
403 - Forbidden
Request:
curl -L \
-X DELETE \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID
Response schema (Status: 204):
GET /users/{username}/projectsV2/{project_number}/views/{view_number}/items
List items in a user project with the saved view's filter applied.
accept (string)application/vnd.github+json is recommended.project_number (integer) (required)
The project's number.
username (string) (required)
The handle for the GitHub user account.
view_number (integer) (required)
The number that identifies the project view.
fields (string)
Limit results to specific fields, by their IDs. If not specified, the
title field will be returned.
Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
before (string)
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 (string)
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 (integer)
The number of results per page (max 100). For more information, see "Using pagination in the REST API."
Default: 30
200 - OK
304 - Not modified
401 - Requires authentication
403 - Forbidden
404 - Resource not found
Request:
curl -L \
-X GET \
https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/views/VIEW_NUMBER/items
Response schema (Status: 200):
Same response schema as List items for an organization owned project.