Skip to content
forgit api docs

List issue fields for an organization

GET
/orgs/{org}/issue-fields

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

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
org
required
string

The organization name. The name is not case sensitive.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Array<object>
Issue Field

A custom attribute defined at the organization level for attaching structured data to issues.

object
id
required

The unique identifier of the issue field.

integer
node_id
required

The node identifier of the issue field.

string
name
required

The name of the issue field.

string
description

The description of the issue field.

string
nullable
data_type
required

The data type of the issue field.

string
Allowed values: text date single_select multi_select number
visibility

The visibility of the issue field. Can be organization_members_only (visible only within the organization) or all (visible to all users who can see issues).

string
Allowed values: organization_members_only all
options

Available options for single select and multi select fields.

Array<object>
nullable
object
id
required

The unique identifier of the option.

integer
name
required

The name of the option.

string
description

The description of the option.

string
nullable
color

The color of the option.

string
nullable
Allowed values: gray blue green yellow orange red pink purple
priority

The priority of the option for ordering.

integer
nullable
created_at

The time the option was created.

string format: date-time
updated_at

The time the option was last updated.

string format: date-time
created_at

The time the issue field was created.

string format: date-time
updated_at

The time the issue field was last updated.

string format: date-time
Examples
Example default 
[
  {
    "id": 1,
    "node_id": "IFT_kwDNAd3NAZo",
    "name": "Text field",
    "description": "DRI",
    "data_type": "text",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  },
  {
    "id": 2,
    "node_id": "IFSS_kwDNAd3NAZs",
    "name": "Priority",
    "description": "Level of importance",
    "data_type": "single_select",
    "options": [
      {
        "id": 1,
        "name": "High",
        "color": "red"
      },
      {
        "id": 2,
        "name": "Medium",
        "color": "yellow"
      },
      {
        "id": 3,
        "name": "Low",
        "color": "green"
      }
    ],
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  },
  {
    "id": 3,
    "node_id": "IFMS_kwDNAd3NAZt",
    "name": "Categories",
    "description": "Issue categories",
    "data_type": "multi_select",
    "options": [
      {
        "id": 4,
        "name": "Frontend",
        "color": "blue"
      },
      {
        "id": 5,
        "name": "Backend",
        "color": "green"
      },
      {
        "id": 6,
        "name": "Infrastructure",
        "color": "purple"
      }
    ],
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  }
]

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}