View as Markdown
GitLab icon

GitLab ACTION

List Groups

List all groups. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GitLab account once, then configure and run List Groups from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Groups inputs
Property Type Description
minAccessLevel Minimum Access Level integer
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).
Optional
topLevelOnly Top Level Only boolean
Limit to top-level groups, excluding all subgroups
Optional
search Search string
Return the list of authorized groups matching the search criteria. Order By must be undefined or similarity when search is provided
Optional
orderBy Order By string
Order groups by name, path, id, or similarity. Default is name. Must be similarity when search is provided
Optional
sort Sort string
Sort order. Default is asc. Must be one of: asc or desc
Optional
active Active boolean
Limit by groups that are not archived and not marked for deletion
Optional
archived Archived boolean
Limit by groups that are archived
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
gitlab-list-groups
Version
0.0.2
App
GitLab
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes