---
title: "List groups"
method: GET
path: "/api/projects/{projectId}/groups"
tags: ["Group"]
---

# List groups

`GET /api/projects/{projectId}/groups`

Retrieve a paginated list of groups for a project, with optional search filtering.

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `search` string
- `page` number
- `perPage` number

## Response `200`

Paginated list of groups

- object — Paginated list of groups
  - `results` object[], required — List of groups
    - `id` string, uuid, required — Unique identifier of the group
    - `name` string, required — Name of the group
    - `description` string — Description of the group
    - `projectId` string, uuid, required — ID of the project this group belongs to
    - `permissions` string[], nullable, required — List of permissions granted to this group
    - `filePermissions` object[], nullable — File-level permissions for this group
      - `id` string, nullable — Unique identifier of the file permission
      - `effect` 'allow' | 'deny', required — Whether this permission allows or denies the actions
      - `actions` string[], nullable, required — List of actions this permission applies to
      - `patterns` string, nullable — Glob pattern to match file paths
    - `roleId` string, uuid — ID of the access profile managing this group
    - `role` object, nullable — Access profile that manages this group
      - `id` string, uuid, required — Unique identifier of the role
      - `name` string, required — Name of the role
      - `description` string — Description of the role
  - `paginate` object, required — Pagination metadata
    - `current` number, required — Current page number
    - `from` number, required — Starting record number on the current page
    - `to` number, required — Ending record number on the current page
    - `total` number, required — Total number of records
    - `pageSize` number, required — Number of records per page

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)