Skip to content
forgit api docs

Get a label

GET
/repos/{owner}/{repo}/labels/{name}

Gets a label using the given name.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

The account owner of the repository. The name is not case sensitive.

repo
required
string

The name of the repository without the .git extension. The name is not case sensitive.

name
required
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Label

Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

object
id
required

Unique identifier for the label.

integer format: int64
node_id
required
string
url
required

URL for the label

string format: uri
name
required

The name of the label.

string
description
required

Optional description of the label, such as its purpose.

string
nullable
color
required

6-character hex code, without the leading #, identifying the color

string
default
required

Whether this label comes by default in a new repository.

boolean
Examples
Example default 
{
  "id": 208045946,
  "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
  "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
  "name": "bug",
  "description": "Something isn't working",
  "color": "f29513",
  "default": true
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}