Points de terminaison de l’API REST pour les champs de projet

List project fields for organization

List all fields for a specific organization-owned project.

Jetons d'accès granulaires pour «List project fields for organization»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

"Projects" organization permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour «List project fields for organization »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`project_number` integer Requis The project's number.
`org` string Requis The organization name. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Par défaut: `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."

Codes d’état de réponse HTTP pour «List project fields for organization »

Code de statut	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemples de code pour «List project fields for organization »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2026-03-10" \
  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"
  }
]

Add a field to an organization-owned project.

Jetons d'accès granulaires pour «Add a field to an organization-owned project.»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

"Projects" organization permissions (write)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour «Add a field to an organization-owned project. »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`project_number` integer Requis The project's number.
`org` string Requis The organization name. The name is not case sensitive.

Nom, Type, Description

issue_field_id integer Requis

The ID of the IssueField to create the field for.

name string Requis

The name of the field.

data_type string Requis

The field's data type.

Valeur: iteration

single_select_options array of objects

The options available for single select fields. At least one option must be provided when creating a single select field.

Properties of single_select_options

Nom, Type, Description
`name` string The display name of the option.
`color` string The color associated with the option. Peut être l'un des: `BLUE`, `GRAY`, `GREEN`, `ORANGE`, `PINK`, `PURPLE`, `RED`, `YELLOW`
`description` string The description of the option.

iteration_configuration object Requis

The configuration for iteration fields.

Properties of iteration_configuration

Nom, Type, Description

start_date string

The start date of the first iteration.

duration integer

The default duration for iterations in days. Individual iterations can override this value.

iterations array of objects

Zero or more iterations for the field.

Properties of iterations

Nom, Type, Description
`title` string The title of the iteration.
`start_date` string The start date of the iteration.
`duration` integer The duration of the iteration in days.

Codes d’état de réponse HTTP pour «Add a field to an organization-owned project. »

Code de statut	Description
`201`	Response for adding a field to an organization-owned project.
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour «Add a field to an organization-owned project. »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemples de requête

Select the example type

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

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/fields \
  -d '{"name":"Team notes","data_type":"text"}'

Response for adding a field to an organization-owned project.

Status: 201

{
  "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"
}

Get project field for organization

Get a specific field for an organization-owned project.

Jetons d'accès granulaires pour «Get project field for organization»

Ce point de terminaison fonctionne avec les types de tokens à granularité fine suivants:

Le token à granularité fine doit disposer de l’ensemble d’autorisations suivant:

"Projects" organization permissions (read)

Ce point de terminaison peut être utilisé sans authentification ou sans les autorisations mentionnées ci-dessus si seules les ressources publiques sont demandées.

Paramètres pour «Get project field for organization »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`project_number` integer Requis The project's number.
`field_id` integer Requis The unique identifier of the field.
`org` string Requis The organization name. The name is not case sensitive.

Codes d’état de réponse HTTP pour «Get project field for organization »

Code de statut	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemples de code pour «Get project field for organization »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2026-03-10" \
  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": {
        "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"
}

List project fields for user

List all fields for a specific user-owned project.

Jetons d'accès granulaires pour «List project fields for user»

Ce point de terminaison ne fonctionne pas avec les jetons d’accès utilisateur d’application GitHub, les jetons d’accès d’installation d’application GitHub ou les jetons d’accès personnels affinés.

Paramètres pour «List project fields for user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`project_number` integer Requis The project's number.
`username` string Requis The handle for the GitHub user account.

Paramètres de requête
Nom, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Par défaut: `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."

Codes d’état de réponse HTTP pour «List project fields for user »

Code de statut	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemples de code pour «List project fields for user »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2026-03-10" \
  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"
  }
]

Add field to user owned project

Add a field to a specified user owned project.

Jetons d'accès granulaires pour «Add field to user owned project»

Paramètres pour «Add field to user owned project »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`username` string Requis The handle for the GitHub user account.
`project_number` integer Requis The project's number.

Nom, Type, Description

name string Requis

The name of the field.

data_type string Requis

The field's data type.

Valeur: iteration

single_select_options array of objects

The options available for single select fields. At least one option must be provided when creating a single select field.

Properties of single_select_options

Nom, Type, Description
`name` string The display name of the option.
`color` string The color associated with the option. Peut être l'un des: `BLUE`, `GRAY`, `GREEN`, `ORANGE`, `PINK`, `PURPLE`, `RED`, `YELLOW`
`description` string The description of the option.

iteration_configuration object Requis

The configuration for iteration fields.

Properties of iteration_configuration

Nom, Type, Description

start_date string

The start date of the first iteration.

duration integer

The default duration for iterations in days. Individual iterations can override this value.

iterations array of objects

Zero or more iterations for the field.

Properties of iterations

Nom, Type, Description
`title` string The title of the iteration.
`start_date` string The start date of the iteration.
`duration` integer The duration of the iteration in days.

Codes d’état de réponse HTTP pour «Add field to user owned project »

Code de statut	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour «Add field to user owned project »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemples de requête

Select the example type

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

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/fields \
  -d '{"name":"Team notes","data_type":"text"}'

Response

Status: 201

{
  "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"
}

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`project_number` integer Requis The project's number.
`field_id` integer Requis The unique identifier of the field.
`username` string Requis The handle for the GitHub user account.

Codes d’état de réponse HTTP pour «Get project field for user »

Code de statut	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden

Exemples de code pour «Get project field for user »

Si vous accédez à GitHub à GHE.com, remplacez api.github.com par le sous-domaine dédié de votre entreprise à api.SUBDOMAIN.ghe.com.

Exemple de requête

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: 2026-03-10" \
  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": {
        "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"
}