Search Issues

GET 
/api/v5/search/issues

Request

Query Parameters

access_token string

User authorization code

page integer

Current page number, maximum is 100.

per_page integer

The number of items per page, with a maximum of 50.

q stringrequired

Search keyword

sort string

sort_field: The sorting field,可以选择 created_at (creation time) or last_push_at (update time), with a default of best match.

order string

Sort order (default: desc)

repo string

Repository path

state string

Filter issues by their specified states, open or closed.

Responses

200

Successful Response

Response Headers

application/json

Schema

Schema

Array [
idinteger
html_urlstring
numberstring
statestring
titlestring
bodystring
repository object
idinteger
full_namestring
human_namestring
pathstring
namestring
urlstring
owner object
avatar_urlstring
html_urlstring
idstring
loginstring
namestring
typestring
created_atstring
updated_atstring
labels object[]
Array [
object
]
priorityinteger
commentsinteger
parent_idinteger
]

Example (auto)

[
  {
    "id": 0,
    "html_url": "string",
    "number": "string",
    "state": "string",
    "title": "string",
    "body": "string",
    "repository": {
      "id": 0,
      "full_name": "string",
      "human_name": "string",
      "path": "string",
      "name": "string",
      "url": "string",
      "owner": {
        "avatar_url": "string",
        "html_url": "string",
        "id": "string",
        "login": "string",
        "name": "string",
        "type": "string"
      }
    },
    "created_at": "string",
    "updated_at": "string",
    "labels": [
      {}
    ],
    "priority": 0,
    "comments": 0,
    "parent_id": 0
  }
]

1

Successful Example

{
  "id": 548499,
  "html_url": "https://gitcode.com/youlai/vue3-element-admin/issues/1",
  "number": "1",
  "state": "open",
  "title": "test",
  "body": "test",
  "repository": {
    "id": 3771502,
    "full_name": "youlai/vue3-element-admin",
    "human_name": "YouKai Open Source Organization / vue3-element-admin",
    "path": "vue3-element-admin",
    "name": "vue3-element-admin",
    "url": "https://gitcode.com/youlai/vue3-element-admin",
    "owner": {
      "avatar_url": "https://cdn-img.gitcode.com/fc/ae/3f96c31289ae838297c61f385af9c2e6357216a1906205f56d50f3e268319d8b.png?time=1724590827689",
      "html_url": "https://gitcode.com/u013737132",
      "id": "6553a045ac27540b6bfcb436",
      "login": "u013737132",
      "name": "YouLai Technology",
      "type": "User"
    }
  },
  "created_at": "2024-11-07T18:11:23+08:00",
  "updated_at": "2024-11-07T18:11:23+08:00",
  "labels": [],
  "priority": 0,
  "comments": 0,
  "parent_id": 0
}

2

Successful Example

{
  "id": 518776,
  "html_url": "https://gitcode.com/openUBMC-test/openubmc-ci/issues/4",
  "number": "4",
  "state": "open",
  "title": "test_1",
  "body": "11111",
  "repository": {
    "id": 4261097,
    "full_name": "openUBMC-test/openubmc-ci",
    "human_name": "openUBMC-test / openubmc-ci",
    "path": "openubmc-ci",
    "name": "openubmc-ci",
    "url": "https://gitcode.com/openUBMC-test/openubmc-ci",
    "owner": {
      "avatar_url": "https://cdn-img.gitcode.com/fd/ab/256f0d7a9b2b771a883a9a2975f6bb8804dbcc53df334a63a508306f86fe6c2c.jpg",
      "html_url": "https://gitcode.com/levi3053",
      "id": "671af08b9a767f4c7b6b0681",
      "login": "levi3053",
      "name": "BellllllYu@N.L¡",
      "type": "User"
    }
  },
  "created_at": "2024-11-01T14:12:21+08:00",
  "updated_at": "2024-11-01T14:15:00+08:00",
  "labels": [],
  "priority": 0,
  "comments": 2,
  "parent_id": 0
}