Project labels API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Use this API to manage project labels.

For group labels, use the group labels API.

List all project labels

Lists all labels for a specified project.

By default, this request returns 20 results at a time because the API results are paginated.

GET /projects/:id/labels

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`with_counts`	boolean	no	Whether or not to include issue and merge request counts. Defaults to `false`.
`include_ancestor_groups`	boolean	no	Include ancestor groups. Defaults to `true`.
`search`	string	no	Keyword to filter labels by.
`archived`	boolean	no	Whether the label is archived. Returns all labels, when not set. Requires the `labels_archive` feature flag to be enabled.

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true"

Example response:

[
  {
    "id" : 1,
    "name" : "bug",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "Bug reported by user",
    "description_html": "Bug reported by user",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": 10,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 4,
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "name" : "confirmed",
    "description": "Confirmed issue",
    "description_html": "Confirmed issue",
    "open_issues_count": 2,
    "closed_issues_count": 5,
    "open_merge_requests_count": 0,
    "subscribed": false,
    "priority": null,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 7,
    "name" : "critical",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "Critical issue. Need fix ASAP",
    "description_html": "Critical issue. Need fix ASAP",
    "open_issues_count": 1,
    "closed_issues_count": 3,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": null,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 8,
    "name" : "documentation",
    "color" : "#f0ad4e",
    "text_color" : "#FFFFFF",
    "description": "Issue about documentation",
    "description_html": "Issue about documentation",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 2,
    "subscribed": false,
    "priority": null,
    "is_project_label": false,
    "archived": false
  },
  {
    "id" : 9,
    "color" : "#5cb85c",
    "text_color" : "#FFFFFF",
    "name" : "enhancement",
    "description": "Enhancement proposal",
    "description_html": "Enhancement proposal",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": true,
    "priority": null,
    "is_project_label": true,
    "archived": false
  }
]

Retrieve a project label

Retrieves a specified label for a project.

GET /projects/:id/labels/:label_id

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a project’s label.
`include_ancestor_groups`	boolean	no	Include ancestor groups. Defaults to `true`.

curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/bug"

Example response:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "Bug reported by user",
  "description_html": "Bug reported by user",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": false,
  "priority": 10,
  "is_project_label": true,
  "archived": false
}

Create a project label

Creates a label for a specified project with the specified name and color.

POST /projects/:id/labels

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`name`	string	yes	The name of the label
`color`	string	yes	The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names
`description`	string	no	The description of the label
`priority`	integer	no	The priority of the label. Must be greater or equal than zero or `null` to remove the priority.
`archived`	boolean	no	Whether the label is archived. Defaults to `false`. Requires the `labels_archive` feature flag to be enabled.

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels" \
  --data "name=feature&color=#5843AD"

Example response:

{
  "id" : 10,
  "name" : "feature",
  "color" : "#5843AD",
  "text_color" : "#FFFFFF",
  "description":null,
  "description_html":null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

Delete a project label

Deletes a specified label from a project.

DELETE /projects/:id/labels/:label_id

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a group’s label.

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/bug"

An older endpoint DELETE /projects/:id/labels with name in the parameters is still available, but deprecated.

Update a project label

Updates a specified label for a project with a new name or color. At least one parameter is required to update the label.

PUT /projects/:id/labels/:label_id

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a group’s label.
`new_name`	string	yes if `color` is not provided	The new name of the label
`color`	string	yes if `new_name` is not provided	The color of the label given in 6-digit hex notation with leading ‘#’ sign (for example, #FFAABB) or one of the CSS color names
`description`	string	no	The new description of the label
`priority`	integer	no	The new priority of the label. Must be greater or equal than zero or `null` to remove the priority.
`archived`	boolean	no	Whether the label is archived. Requires the `labels_archive` feature flag to be enabled.

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/documentation" \
  --data "new_name=docs&color=#8E44AD&description=Documentation"

Example response:

{
  "id" : 8,
  "name" : "docs",
  "color" : "#8E44AD",
  "text_color" : "#FFFFFF",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

An older endpoint PUT /projects/:id/labels with name or label_id in the parameters is still available, but deprecated.

Promote a project label to a group label

Promotes a specified project label to a group label. The label keeps its ID.

PUT /projects/:id/labels/:label_id/promote

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a group’s label.

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/documentation/promote"

Example response:

{
  "id" : 8,
  "name" : "documentation",
  "color" : "#8E44AD",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false,
  "archived": false
}

An older endpoint PUT /projects/:id/labels/promote with name in the parameters is still available, but deprecated.

Subscribes the authenticated user to a specified project label to receive notifications. If the user is already subscribed to the label, status code 304 is returned.

POST /projects/:id/labels/:label_id/subscribe

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a project’s label

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/labels/1/subscribe"

Example response:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "Bug reported by user",
  "description_html": "Bug reported by user",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": true,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

Unsubscribe from a project label

Unsubscribes the authenticated user from a specified project label to stop receiving notifications. If the user is not subscribed to the label, status code 304 is returned.

POST /projects/:id/labels/:label_id/unsubscribe

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`label_id`	integer or string	yes	The ID or title of a project’s label

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/labels/1/unsubscribe"

Project labels API

List all project labels

Retrieve a project label

Create a project label

Delete a project label

Update a project label

Promote a project label to a group label

Subscribe to a project label

Unsubscribe from a project label