Points de terminaison d’API REST pour les types de problèmes

List issue types for an organization

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Jetons d’accès affinés pour « List issue types for an organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Issue Types" organization permissions (read)

Paramètres pour « List issue types for an 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
`org` string Obligatoire The organization name. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « List issue types for an organization »

Code d’état	Description
`200`	OK
`404`	Resource not found

Exemples de code pour « List issue types for an organization »

Exemple de requête

get/orgs/{org}/issue-types

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/issue-types

Response

Status: 200

[
  {
    "id": 410,
    "node_id": "IT_kwDNAd3NAZo",
    "name": "Task",
    "description": "A specific piece of work",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  },
  {
    "id": 411,
    "node_id": "IT_kwDNAd3NAZs",
    "name": "Bug",
    "description": "An unexpected problem or behavior",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  }
]

Create issue type for an organization

Create a new issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Jetons d’accès affinés pour « Create issue type for an organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Issue Types" organization permissions (write)

Paramètres pour « Create issue type for an 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
`org` string Obligatoire The organization name. The name is not case sensitive.

Paramètres du corps
Nom, Type, Description
`name` string Obligatoire Name of the issue type.
`is_enabled` boolean Obligatoire Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Peut être: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Codes d’état de la réponse HTTP pour « Create issue type for an organization »

Code d’état	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Create issue type for an organization »

Exemple de requête

post/orgs/{org}/issue-types

curl -L \
  -X POST \
  -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/issue-types \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Update issue type for an organization

Updates an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Jetons d’accès affinés pour « Update issue type for an organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Issue Types" organization permissions (write)

Paramètres pour « Update issue type for an 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
`org` string Obligatoire The organization name. The name is not case sensitive.
`issue_type_id` integer Obligatoire The unique identifier of the issue type.

Paramètres du corps
Nom, Type, Description
`name` string Obligatoire Name of the issue type.
`is_enabled` boolean Obligatoire Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Peut être: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Codes d’état de la réponse HTTP pour « Update issue type for an organization »

Code d’état	Description
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Update issue type for an organization »

Exemple de requête

put/orgs/{org}/issue-types/{issue_type_id}

curl -L \
  -X PUT \
  -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/issue-types/ISSUE_TYPE_ID \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Delete issue type for an organization

Deletes an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Jetons d’accès affinés pour « Delete issue type for an organization »

Ce point de terminaison fonctionne avec les types de jetons précis suivants:

Le jeton précis doit avoir l’ensemble d’autorisations suivant:

"Issue Types" organization permissions (write)

Paramètres pour « Delete issue type for an 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
`org` string Obligatoire The organization name. The name is not case sensitive.
`issue_type_id` integer Obligatoire The unique identifier of the issue type.

Codes d’état de la réponse HTTP pour « Delete issue type for an organization »

Code d’état	Description
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Delete issue type for an organization »

Exemple de requête

delete/orgs/{org}/issue-types/{issue_type_id}

curl -L \
  -X DELETE \
  -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/issue-types/ISSUE_TYPE_ID

Response

Status: 204