Search labels

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination). 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](https://docs.github.com/[email protected]/rest/reference/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: `q=bug+defect+enhancement&repository_id=64778136` The labels that best match the query appear first in the search results.

GET/search/labels

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Query Parameters

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](https://docs.github.com/[email protected]/rest/reference/search#constructing-a-search-query).
sort string optional: Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/[email protected]/rest/reference/search#ranking-search-results)
order string optional: 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`.
per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.

Responses

application/json object

Response

incomplete_results boolean

required

items array[Label Search Result Item object]

required

items Label Search Result Item object

Label Search Result Item

color string

required

default boolean

required

description string

requirednullable

id integer

required

name string

required

node_id string

required

score number

required

text_matches Search Result Text Matches array[object]

optional

url string<uri>

required

total_count integer

required

Response Example: 200 application/json

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

Not modified

application/json Basic Error object

Forbidden

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Basic Error object

Resource not found

documentation_url string

optional

message string

optional

status string

optional

url string

optional

application/json Validation Error object

Validation failed

documentation_url string

required

errors array[object]

optional

items object

code string

required

field string

optional

index integer

optional

message string

optional

resource string

optional

value

optional

message string

required

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

repository_id *

The id of the repository.

q *

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](https://docs.github.com/[email protected]/rest/reference/search#constructing-a-search-query).

sort

Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/[email protected]/rest/reference/search#ranking-search-results)

order

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

per_page

Results per page (max 100)

page

Page number of the results to fetch.

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/search/labels