REST API endpoints for Project fields

List project fields for organization

List all fields for a specific organization-owned project.

Fine-grained access tokens for "List project fields for organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Projects" organization permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "List project fields for organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`project_number` integer Required The project's number.
`org` string Required The organization name. The name is not case sensitive.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`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."

HTTP response status codes for "List project fields for organization"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "List project fields for organization"

Request example

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200

[ { "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": { "html": "Low", "raw": "Low" }, "color": "GREEN", "description": { "html": "Low priority items", "raw": "Low priority items" } }, { "id": "option_2", "name": { "html": "Medium", "raw": "Medium" }, "color": "YELLOW", "description": { "html": "Medium priority items", "raw": "Medium priority items" } }, { "id": "option_3", "name": { "html": "High", "raw": "High" }, "color": "RED", "description": { "html": "High priority items", "raw": "High priority items" } } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }, { "id": 67891, "node_id": "PVTF_lADOABCD9876543210", "name": "Status", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_4", "name": { "html": "Todo", "raw": "Todo" }, "color": "GRAY", "description": { "html": "Items to be worked on", "raw": "Items to be worked on" } }, { "id": "option_5", "name": { "html": "In Progress", "raw": "In Progress" }, "color": "BLUE", "description": { "html": "Items currently being worked on", "raw": "Items currently being worked on" } }, { "id": "option_6", "name": { "html": "Done", "raw": "Done" }, "color": "GREEN", "description": { "html": "Completed items", "raw": "Completed items" } } ], "created_at": "2022-04-29T10:30:00Z", "updated_at": "2022-04-29T10:30:00Z" }, { "id": 24680, "node_id": "PVTF_lADOABCD2468024680", "name": "Team notes", "data_type": "text", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-05-15T08:00:00Z", "updated_at": "2022-05-15T08:00:00Z" }, { "id": 13579, "node_id": "PVTF_lADOABCD1357913579", "name": "Story points", "data_type": "number", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-06-01T14:30:00Z", "updated_at": "2022-06-01T14:30:00Z" }, { "id": 98765, "node_id": "PVTF_lADOABCD9876598765", "name": "Due date", "data_type": "date", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-06-10T09:15:00Z", "updated_at": "2022-06-10T09:15:00Z" }, { "id": 11223, "node_id": "PVTF_lADOABCD1122311223", "name": "Sprint", "data_type": "iteration", "project_url": "https://api.github.com/projects/67890", "configuration": { "duration": 14, "start_day": 1, "iterations": [ { "id": "iter_1", "title": { "html": "Sprint 1", "raw": "Sprint 1" }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", "title": { "html": "Sprint 2", "raw": "Sprint 2" }, "start_date": "2022-07-15", "duration": 14 } ] }, "created_at": "2022-06-20T16:45:00Z", "updated_at": "2022-06-20T16:45:00Z" } ]

Get project field for organization

Get a specific field for an organization-owned project.

Fine-grained access tokens for "Get project field for organization"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Projects" organization permissions (read)

This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.

Parameters for "Get project field for organization"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`project_number` integer Required The project's number.
`field_id` integer Required The unique identifier of the field.
`org` string Required The organization name. The name is not case sensitive.

HTTP response status codes for "Get project field for organization"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "Get project field for organization"

Request example

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200

{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }

List project fields for user

List all fields for a specific user-owned project.

Fine-grained access tokens for "List project fields for user"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "List project fields for user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`project_number` integer Required The project's number.
`username` string Required The handle for the GitHub user account.

Query parameters
Name, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`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."

HTTP response status codes for "List project fields for user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "List project fields for user"

Request example

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields

Response

Status: 200

[ { "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": { "html": "Low", "raw": "Low" }, "color": "GREEN", "description": { "html": "Low priority items", "raw": "Low priority items" } }, { "id": "option_2", "name": { "html": "Medium", "raw": "Medium" }, "color": "YELLOW", "description": { "html": "Medium priority items", "raw": "Medium priority items" } }, { "id": "option_3", "name": { "html": "High", "raw": "High" }, "color": "RED", "description": { "html": "High priority items", "raw": "High priority items" } } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }, { "id": 67891, "node_id": "PVTF_lADOABCD9876543210", "name": "Status", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_4", "name": { "html": "Todo", "raw": "Todo" }, "color": "GRAY", "description": { "html": "Items to be worked on", "raw": "Items to be worked on" } }, { "id": "option_5", "name": { "html": "In Progress", "raw": "In Progress" }, "color": "BLUE", "description": { "html": "Items currently being worked on", "raw": "Items currently being worked on" } }, { "id": "option_6", "name": { "html": "Done", "raw": "Done" }, "color": "GREEN", "description": { "html": "Completed items", "raw": "Completed items" } } ], "created_at": "2022-04-29T10:30:00Z", "updated_at": "2022-04-29T10:30:00Z" }, { "id": 24680, "node_id": "PVTF_lADOABCD2468024680", "name": "Team notes", "data_type": "text", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-05-15T08:00:00Z", "updated_at": "2022-05-15T08:00:00Z" }, { "id": 13579, "node_id": "PVTF_lADOABCD1357913579", "name": "Story points", "data_type": "number", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-06-01T14:30:00Z", "updated_at": "2022-06-01T14:30:00Z" }, { "id": 98765, "node_id": "PVTF_lADOABCD9876598765", "name": "Due date", "data_type": "date", "project_url": "https://api.github.com/projects/67890", "created_at": "2022-06-10T09:15:00Z", "updated_at": "2022-06-10T09:15:00Z" }, { "id": 11223, "node_id": "PVTF_lADOABCD1122311223", "name": "Sprint", "data_type": "iteration", "project_url": "https://api.github.com/projects/67890", "configuration": { "duration": 14, "start_day": 1, "iterations": [ { "id": "iter_1", "title": { "html": "Sprint 1", "raw": "Sprint 1" }, "start_date": "2022-07-01", "duration": 14 }, { "id": "iter_2", "title": { "html": "Sprint 2", "raw": "Sprint 2" }, "start_date": "2022-07-15", "duration": 14 } ] }, "created_at": "2022-06-20T16:45:00Z", "updated_at": "2022-06-20T16:45:00Z" } ]

Get project field for user

Get a specific field for a user-owned project.

Fine-grained access tokens for "Get project field for user"

This endpoint does not work with GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens.

Parameters for "Get project field for user"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`project_number` integer Required The project's number.
`field_id` integer Required The unique identifier of the field.
`username` string Required The handle for the GitHub user account.

HTTP response status codes for "Get project field for user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Code samples for "Get project field for user"

Request example

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

curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields/FIELD_ID

Response

Status: 200

{ "id": 12345, "node_id": "PVTF_lADOABCD1234567890", "name": "Priority", "data_type": "single_select", "project_url": "https://api.github.com/projects/67890", "options": [ { "id": "option_1", "name": "Low", "color": "GREEN", "description": "Low priority items" }, { "id": "option_2", "name": "Medium", "color": "YELLOW", "description": "Medium priority items" }, { "id": "option_3", "name": "High", "color": "RED", "description": "High priority items" } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" }