---
title: "Get Client Groups"
method: GET
path: "/api/v1/groups/groups-by-client"
tags: ["User APIs", "groups"]
---

# Get Client Groups

`GET /api/v1/groups/groups-by-client`

Get client groups with pagination, sorting and filtering.

Omit ``size`` to return all groups without pagination.

## Query parameters

- `filters` string, nullable
- `page` integer
- `size` integer, nullable
- `sort_by` string, nullable
- `sort_order` string, nullable

## Response `200`

Successful Response

- PaginatedGroupsResponse
  - `total` integer, required
  - `items` GroupsPageRead[], required
    - `name` string, required
    - `description` string, nullable
    - `transaction_limit` number, nullable
    - `allocated_amount` number, nullable
    - `client_id` string, uuid, required
    - `is_default` boolean, nullable
    - `is_active` boolean, nullable
    - `meta_data` object, nullable
    - `user_ids` string[], nullable
    - `block_role` 'block_user' | 'block_admin' — Additive Block role values stored directly on ``users.block_role`` and ``groups.block_role`` (``block_role_enum`` Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.
    - `id` string, uuid, required
    - `key` string, required
    - `current_consumption` number, nullable
    - `mcp_period_limit` number, nullable
    - `mcp_period_consumption` number, nullable
    - `mcp_period_reset_date` string, date-time, nullable
    - `mcp_period_next_reset_date` string, date-time, nullable
    - `mcp_period_start_date` string, date-time, nullable
    - `mcp_access_revoked` boolean, nullable
    - `mcp_access_revoked_at` string, date-time, nullable
    - `client_limit` number, nullable
  - `pages` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api.md) · [All operations](https://skmtc.net/carbonarc/apis/carbon-arc-client-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/carbonarc/carbon-arc-client-admin-api/revisions/a8ca30023371/schema)