Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Gitlab Provider
  4. API Docs
  5. getGroupLabels
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

gitlab.getGroupLabels

gitlab logo
Viewing docs for GitLab v10.0.0
published on Friday, Jun 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gitlab

    The gitlab.getGroupLabels data source retrieves a list of labels for a group.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

// Retrieve all labels for a group
const example = gitlab.getGroupLabels({
    group: "my-group",
});

    import pulumi
import pulumi_gitlab as gitlab

# Retrieve all labels for a group
example = gitlab.get_group_labels(group="my-group")

    package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v10/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Retrieve all labels for a group
		_, err := gitlab.GetGroupLabels(ctx, &gitlab.GetGroupLabelsArgs{
			Group: "my-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;

return await Deployment.RunAsync(() => 
{
    // Retrieve all labels for a group
    var example = GitLab.GetGroupLabels.Invoke(new()
    {
        Group = "my-group",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetGroupLabelsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Retrieve all labels for a group
        final var example = GitlabFunctions.getGroupLabels(GetGroupLabelsArgs.builder()
            .group("my-group")
            .build());

    }
}

    variables:
  # Retrieve all labels for a group
  example:
    fn::invoke:
      function: gitlab:getGroupLabels
      arguments:
        group: my-group

    pulumi {
  required_providers {
    gitlab = {
      source = "pulumi/gitlab"
    }
  }
}

data "gitlab_getgrouplabels" "example" {
  group = "my-group"
}

# Retrieve all labels for a group

    Using getGroupLabels

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGroupLabels(args: GetGroupLabelsArgs, opts?: InvokeOptions): Promise<GetGroupLabelsResult>
function getGroupLabelsOutput(args: GetGroupLabelsOutputArgs, opts?: InvokeOptions): Output<GetGroupLabelsResult>
    def get_group_labels(group: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGroupLabelsResult
def get_group_labels_output(group: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGroupLabelsResult]
    func GetGroupLabels(ctx *Context, args *GetGroupLabelsArgs, opts ...InvokeOption) (*GetGroupLabelsResult, error)
func GetGroupLabelsOutput(ctx *Context, args *GetGroupLabelsOutputArgs, opts ...InvokeOption) GetGroupLabelsResultOutput

    > Note: This function is named GetGroupLabels in the Go SDK.

    public static class GetGroupLabels 
{
    public static Task<GetGroupLabelsResult> InvokeAsync(GetGroupLabelsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupLabelsResult> Invoke(GetGroupLabelsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupLabelsResult> getGroupLabels(GetGroupLabelsArgs args, InvokeOptions options)
public static Output<GetGroupLabelsResult> getGroupLabels(GetGroupLabelsArgs args, InvokeOptions options)

    fn::invoke:
  function: gitlab:index/getGroupLabels:getGroupLabels
  arguments:
    # arguments dictionary
    data "gitlab_getgrouplabels" "name" {
    # arguments
}

    The following arguments are supported:

    Group string
    The ID or URL-encoded path of the group.
    Group string
    The ID or URL-encoded path of the group.
    group string
    The ID or URL-encoded path of the group.
    group String
    The ID or URL-encoded path of the group.
    group string
    The ID or URL-encoded path of the group.
    group str
    The ID or URL-encoded path of the group.
    group String
    The ID or URL-encoded path of the group.

    getGroupLabels Result

    The following output properties are available:

    Group string
    The ID or URL-encoded path of the group.
    Id string
    The ID of this data source.
    Labels List<Pulumi.GitLab.Outputs.GetGroupLabelsLabel>
    The list of labels in the group.
    Group string
    The ID or URL-encoded path of the group.
    Id string
    The ID of this data source.
    Labels []GetGroupLabelsLabel
    The list of labels in the group.
    group string
    The ID or URL-encoded path of the group.
    id string
    The ID of this data source.
    labels list(object)
    The list of labels in the group.
    group String
    The ID or URL-encoded path of the group.
    id String
    The ID of this data source.
    labels List<GetGroupLabelsLabel>
    The list of labels in the group.
    group string
    The ID or URL-encoded path of the group.
    id string
    The ID of this data source.
    labels GetGroupLabelsLabel[]
    The list of labels in the group.
    group str
    The ID or URL-encoded path of the group.
    id str
    The ID of this data source.
    labels Sequence[GetGroupLabelsLabel]
    The list of labels in the group.
    group String
    The ID or URL-encoded path of the group.
    id String
    The ID of this data source.
    labels List<Property Map>
    The list of labels in the group.

    Supporting Types

    GetGroupLabelsLabel

    ClosedIssuesCount int
    The number of closed issues with this label.
    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign.
    Description string
    The description of the label.
    Id int
    The ID of the label.
    Name string
    The name of the label.
    OpenIssuesCount int
    The number of open issues with this label.
    OpenMergeRequestsCount int
    The number of open merge requests with this label.
    Subscribed bool
    Whether the authenticated user is subscribed to the label.
    TextColor string
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    ClosedIssuesCount int
    The number of closed issues with this label.
    Color string
    The color of the label given in 6-digit hex notation with leading '#' sign.
    Description string
    The description of the label.
    Id int
    The ID of the label.
    Name string
    The name of the label.
    OpenIssuesCount int
    The number of open issues with this label.
    OpenMergeRequestsCount int
    The number of open merge requests with this label.
    Subscribed bool
    Whether the authenticated user is subscribed to the label.
    TextColor string
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    closed_issues_count number
    The number of closed issues with this label.
    color string
    The color of the label given in 6-digit hex notation with leading '#' sign.
    description string
    The description of the label.
    id number
    The ID of the label.
    name string
    The name of the label.
    open_issues_count number
    The number of open issues with this label.
    open_merge_requests_count number
    The number of open merge requests with this label.
    subscribed bool
    Whether the authenticated user is subscribed to the label.
    text_color string
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    closedIssuesCount Integer
    The number of closed issues with this label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign.
    description String
    The description of the label.
    id Integer
    The ID of the label.
    name String
    The name of the label.
    openIssuesCount Integer
    The number of open issues with this label.
    openMergeRequestsCount Integer
    The number of open merge requests with this label.
    subscribed Boolean
    Whether the authenticated user is subscribed to the label.
    textColor String
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    closedIssuesCount number
    The number of closed issues with this label.
    color string
    The color of the label given in 6-digit hex notation with leading '#' sign.
    description string
    The description of the label.
    id number
    The ID of the label.
    name string
    The name of the label.
    openIssuesCount number
    The number of open issues with this label.
    openMergeRequestsCount number
    The number of open merge requests with this label.
    subscribed boolean
    Whether the authenticated user is subscribed to the label.
    textColor string
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    closed_issues_count int
    The number of closed issues with this label.
    color str
    The color of the label given in 6-digit hex notation with leading '#' sign.
    description str
    The description of the label.
    id int
    The ID of the label.
    name str
    The name of the label.
    open_issues_count int
    The number of open issues with this label.
    open_merge_requests_count int
    The number of open merge requests with this label.
    subscribed bool
    Whether the authenticated user is subscribed to the label.
    text_color str
    The text color of the label given in 6-digit hex notation with leading '#' sign.
    closedIssuesCount Number
    The number of closed issues with this label.
    color String
    The color of the label given in 6-digit hex notation with leading '#' sign.
    description String
    The description of the label.
    id Number
    The ID of the label.
    name String
    The name of the label.
    openIssuesCount Number
    The number of open issues with this label.
    openMergeRequestsCount Number
    The number of open merge requests with this label.
    subscribed Boolean
    Whether the authenticated user is subscribed to the label.
    textColor String
    The text color of the label given in 6-digit hex notation with leading '#' sign.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    Viewing docs for GitLab v10.0.0
    published on Friday, Jun 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gitlab

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial