Get a Specific Issue of a Repository

GET 
/api/v5/repos/:owner/:repo/issues/:number

Request

Path Parameters

owner stringrequired

Repository space address (organization or individual's address path)

repo stringrequired

Repository path (path)

number stringrequired

Issue Number (case-sensitive, do not add #)

Query Parameters

access_token string

User authorization code

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

idintegerrequired

html_urlstringrequired

numberstringrequired

statestringrequired

titlestringrequired

bodystringrequired

user objectrequired

avatar_urlstringrequired

html_urlstringrequired

idstringrequired

loginstringrequired

namestringrequired

repository objectrequired

idintegerrequired

full_namestringrequired

pathstringrequired

namestringrequired

descriptionstringrequired

created_atstringrequired

updated_atstringrequired

assigner objectrequired

object

paasstringrequired

created_atstringrequired

updated_atstringrequired

finished_atstringrequired

labels object[]required

Array [

idinteger

namestring

colorstring

created_atstring

updated_atstring

label added time

]

issue_statestringrequired

commentsintegerrequired

priorityintegerrequired

issue_typestringrequired

issue_state_detail object

titlestringrequired

serialintegerrequired

idintegerrequired

issue_type_detail object

titlestringrequired

idintegerrequired

is_systembooleanrequired

issue_priority_detail object

Issue Priority

idstringrequired

titlestringrequired

milestone objectrequired

created_atstringrequired

descriptionstringrequired

due_onstringrequired

numberintegerrequired

repository_idintegerrequired

statestringrequired

titlestringrequired

updated_atstringrequired

urlstringrequired

custom_fields object[]

Custom field information

Array [

field_namestring

Custom Field Name

field_typestring

Field type. text_single: single line text, text_multi: multi-line text, integer: integer, decimal: decimal, date: date, select_single: single select dropdown, select_multi: multi-select dropdown, member_single: single select member, member_multi: multi-select member

field_visibilitystring

Visibility. 0: Visible to administrators only, 1: Visible to everyone

field_valuesstring[]

Custom field value

]

visibility_reasonstring

Visibility, public: publicly visible, confidential: confidential, visible to project members, other: visible to project members due to other reasons

Example (auto)

{
  "id": 0,
  "html_url": "string",
  "number": "string",
  "state": "string",
  "title": "string",
  "body": "string",
  "user": {
    "avatar_url": "string",
    "html_url": "string",
    "id": "string",
    "login": "string",
    "name": "string"
  },
  "repository": {
    "id": 0,
    "full_name": "string",
    "path": "string",
    "name": "string",
    "description": "string",
    "created_at": "string",
    "updated_at": "string",
    "assigner": {},
    "paas": "string"
  },
  "created_at": "string",
  "updated_at": "string",
  "finished_at": "string",
  "labels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "issue_state": "string",
  "comments": 0,
  "priority": 0,
  "issue_type": "string",
  "issue_state_detail": {
    "title": "string",
    "serial": 0,
    "id": 0
  },
  "issue_type_detail": {
    "title": "string",
    "id": 0,
    "is_system": true
  },
  "issue_priority_detail": {
    "id": "string",
    "title": "string"
  },
  "milestone": {
    "created_at": "string",
    "description": "string",
    "due_on": "string",
    "number": 0,
    "repository_id": 0,
    "state": "string",
    "title": "string",
    "updated_at": "string",
    "url": "string"
  },
  "custom_fields": [
    {
      "field_name": "string",
      "field_type": "string",
      "field_visibility": "string",
      "field_values": [
        "string"
      ]
    }
  ],
  "visibility_reason": "string"
}

Example

{
  "id": 152212,
  "html_url": "https://test.gitcode.net/dengmengmian/test01/issues/3",
  "number": 3,
  "state": "opened",
  "title": "Inspector Gold Film",
  "body": "abcabcabc",
  "user": {
    "avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/fa/fe/f32a9fecc53e890afbd48fd098b0f6c5f20f062581400c76c85e5baab3f0d5b2.png",
    "events_url": null,
    "followers_url": null,
    "following_url": null,
    "gists_url": null,
    "html_url": "https://test.gitcode.net/dengmengmian",
    "id": "661ce4eab470b1430d456154",
    "login": "dengmengmian",
    "member_role": null,
    "name": "MaFan_",
    "organizations_url": null,
    "received_events_url": null,
    "remark": null,
    "repos_url": null,
    "starred_url": null,
    "subscriptions_url": null,
    "type": null,
    "url": null
  },
  "assignee": null,
  "repository": {
    "id": 280713,
    "full_name": "dengmengmian / test01",
    "path": "test01",
    "name": "test01",
    "description": "",
    "created_at": "2024-04-15T16:27:45.090+08:00",
    "updated_at": "2024-04-15T16:27:45.090+08:00",
    "assigner": null,
    "pushed_at": null,
    "paas": null,
    "assignees_number": null,
    "testers_number": null,
    "assignee": null,
    "testers": null
  },
  "created_at": "2024-04-15T21:58:21.188+08:00",
  "updated_at": "2024-04-15T21:58:21.188+08:00",
  "finished_at": null,
  "labels": [],
  "priority": null,
  "issue_type": null,
  "issue_state": "opened",
  "issue_state_detail": null,
  "stage": "New",
  "severity": "Major"
}