Retrieve a group label

GET

/api/v4/groups/{id}/labels/{name}

• GitLab REST API

Retrieves a specified group label.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

The ID of a group

name

required

string

The name of a label

Query Parameters

include_ancestor_groups

boolean

default: true nullable

Include ancestor groups

include_descendant_groups

boolean

nullable

Include descendant groups. This feature was added in GitLab 13.6

only_group_labels

boolean

default: true nullable

Toggle to include only group labels or also project labels. This feature was added in GitLab 13.6

Responses

200

OK

Media type application/json

object

id

integer format: int64

name

string

description

string

text_color

string

description_html

string

color

string

archived

boolean

open_issues_count

integer

closed_issues_count

integer

open_merge_requests_count

integer

subscribed

boolean

Example

{
  "id": 1,
  "name": "bug",
  "description": "Bug reported by user",
  "text_color": "#FFFFFF",
  "description_html": "<p>Bug reported by user</p>",
  "color": "#FF0000",
  "archived": false,
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": false
}

400

Bad Request

404

Not Found