LogoGitpod API Reference

Groups

groups

Methods

List Groups -> GroupsPage<
Group
>
post/gitpod.v1.GroupService/ListGroups

Lists groups with optional pagination.

Use this method to:

  • View all groups
  • Check group memberships
  • Monitor group configurations
  • Audit group access

Examples

  • List all groups:

    Shows all groups with pagination.

    pagination:
  pageSize: 20

  • List with custom page size:

    Shows groups with specified page size.

    pagination:
  pageSize: 50
  token: "next-page-token-from-previous-response"
query Parameters
token: string
Optional
pageSize: number
Optional
(maximum: 100, minimum: 0, default: 25)
Response fields
groups: Array<
Group
>
Optional
pagination: { nextToken }
Optional
Request example
200Example

Domain types

Group = { id, createdAt, name, 3 more... }