Search labels

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

GET /search/labels

Parameters

Name	Type	Description
`repository_id`	`integer`	Required. The id of the repository.
`q`	`string`	Required. The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.
`sort`	`string`	Sorts the results of your query by when the label was `created` or `updated`. Default: best match
`order`	`string`	Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. Default: `desc`

Example

Suppose you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

curl 'https://api.github.com/search/labels?repository_id=64778136&q=bug+defect+enhancement'

The labels that best match for the query appear first in the search results.

Status: 200 OK

{
  "total_count": 2,
  "incomplete_results": false,
  "items": [
    {
      "id": 418327088,
      "node_id": "MDU6TGFiZWw0MTgzMjcwODg=",
      "url": "https://api.github.com/repos/octocat/linguist/labels/enhancement",
      "name": "enhancement",
      "color": "84b6eb",
      "default": true,
      "description": "New feature or request.",
      "score": 1.0
    },
    {
      "id": 418327086,
      "node_id": "MDU6TGFiZWw0MTgzMjcwODY=",
      "url": "https://api.github.com/repos/octocat/linguist/labels/bug",
      "name": "bug",
      "color": "ee0701",
      "default": true,
      "description": "Something isn't working.",
      "score": 1.0
    }
  ]
}