Pontos de extremidade da API REST para tipos de issue

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.

Tokens de acesso refinados para "List issue types for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Issue Types" organization permissions (read)

Parâmetros para "List issue types for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP para "List issue types for an organization"

Código de status	Descrição
`200`	OK
`404`	Resource not found

Exemplos de código para "List issue types for an organization"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Create issue type for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Issue Types" organization permissions (write)

Parâmetros para "Create issue type for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`name` string Obrigatório Name of the issue type.
`is_enabled` boolean Obrigatório Whether or not the issue type is enabled at the organization level.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Pode ser um dos: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Códigos de status de resposta HTTP para "Create issue type for an organization"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemplos de código para "Create issue type for an organization"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Update issue type for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Issue Types" organization permissions (write)

Parâmetros para "Update issue type for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`issue_type_id` integer Obrigatório The unique identifier of the issue type.

Parâmetros do corpo
Nome, Tipo, Descrição
`name` string Obrigatório Name of the issue type.
`is_enabled` boolean Obrigatório Whether or not the issue type is enabled at the organization level.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. Pode ser um dos: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

Códigos de status de resposta HTTP para "Update issue type for an organization"

Código de status	Descrição
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemplos de código para "Update issue type for an organization"

Exemplo de solicitação

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.

Tokens de acesso refinados para "Delete issue type for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Issue Types" organization permissions (write)

Parâmetros para "Delete issue type for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`issue_type_id` integer Obrigatório The unique identifier of the issue type.

Códigos de status de resposta HTTP para "Delete issue type for an organization"

Código de status	Descrição
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemplos de código para "Delete issue type for an organization"

Exemplo de solicitação

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