Get Groups By Client

get/api/v1/admin/clients/{client_id}/groups

Request

Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
URL: https://carbonarc.ai/api/v1/admin/clients/{client_id}/groups
Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

client_idstring required

Query parameters

active_onlyboolean

Response

Successful Response

namestring required

descriptionstring nullable

transaction_limitnumber nullable

allocated_amountnumber nullable

client_idstring uuid required

is_defaultboolean nullable

is_activeboolean nullable

meta_dataobject nullable

user_idsstring[] 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.

idstring uuid required

keystring required

current_consumptionnumber nullable

mcp_period_limitnumber nullable

mcp_period_consumptionnumber nullable

mcp_period_reset_datestring date-time nullable

mcp_period_next_reset_datestring date-time nullable

mcp_period_start_datestring date-time nullable

mcp_access_revokedboolean nullable

mcp_access_revoked_atstring date-time nullable

Changes

No recorded changes to this operation across all 4 revisions of this API.