Sign in
User APIs
groups

Get Group

Get a single group with full computed MCP fields (consumption, next reset date).

get/api/v1/groups/{group_id}

Path parameters

group_idstring uuid required

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