List issue fields for an organization | Sample

1 parameter

orgstringrequired

The organization name. The name is not case sensitive.

2 status codes

200Response

idintegerrequired

The unique identifier of the issue field.

node_idstringrequired

The node identifier of the issue field.

namestringrequired

The name of the issue field.

descriptionstringoptional

The description of the issue field.

data_typestringrequired

The data type of the issue field.

Allowed:textdatesingle_selectmulti_selectnumber

visibilitystringoptional

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).

Allowed:organization_members_onlyall

optionsarray<object>optional

Available options for single select and multi select fields.

created_atstringoptional

The time the issue field was created.

updated_atstringoptional

The time the issue field was last updated.

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned: Resource not found.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.issueFields.list({ org: "acme-inc" });

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

Request

Response

Errors