# List Groups — GitLab

> List all groups. See the documentation

- Key: `gitlab-list-groups`
- Type: Action (Read-only)
- Version: 0.0.2
- App: GitLab (`gitlab`) — https://pipedream.com/apps/gitlab.md
- This page (HTML): https://pipedream.com/apps/gitlab/actions/list-groups
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/gitlab/actions/list-groups/list-groups.mjs

## Description

List all groups. [See the documentation](https://docs.gitlab.com/api/groups/#list-groups)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `minAccessLevel` | `integer` | No | Limit to groups where current user has at least the specified access level. Possible values: 5 (Minimal access), 10 (Guest), 15 (Planner), 20 (Reporter), 25 (Security Manager), 30 (Developer), 40 (Maintainer), or 50 (Owner). |
| `topLevelOnly` | `boolean` | No | Limit to top-level groups, excluding all subgroups |
| `search` | `string` | No | Return the list of authorized groups matching the search criteria. Order By must be undefined or similarity when search is provided |
| `orderBy` | `string` | No | Order groups by name, path, id, or similarity. Default is name. Must be similarity when search is provided |
| `sort` | `string` | No | Sort order. Default is asc. Must be one of: asc or desc |
| `active` | `boolean` | No | Limit by groups that are not archived and not marked for deletion |
| `archived` | `boolean` | No | Limit by groups that are archived |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "gitlab",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "gitlab-list-groups",
  arguments: {
    minAccessLevel: 10,
    topLevelOnly: true,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "gitlab-list-groups",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gitlab: { authProvisionId: "apn_xxxxxxx" },
    minAccessLevel: 10,
    topLevelOnly: true,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "gitlab-list-groups",
    "configured_props": {
      "gitlab": { "authProvisionId": "apn_xxxxxxx" },
      "minAccessLevel": 10,
      "topLevelOnly": true
    }
  }'
```

---

- App: https://pipedream.com/apps/gitlab.md · All apps: https://pipedream.com/apps