---
title: "List individual user groups' AI credit limits"
method: GET
path: "/api/v1/ai/credit-controls/user-groups"
tags: ["AI"]
---

# List individual user groups' AI credit limits

`GET /api/v1/ai/credit-controls/user-groups`

## Request

- Base URL: `https://omniapp.co` (the document declares no server; this is the origin it was published from)
- URL: `https://omniapp.co/api/v1/ai/credit-controls/user-groups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/omniapp/apis/omni-api/docs/api/v1/ai/credit-controls/user-groups/get.ts> (a function with typed inputs; its response is checked against the schema)

List the organization's active individual standard user-group AI credit limits, keyed by user group ID (`userGroupId`). Only user groups with an individual limit appear — everyone else follows the org's user-group default (`userGroupDefaultCredits`). A `null` creditLimit is an explicit unlimited override, distinct from following the default. Paginated via opaque cursors: pass `pageInfo.nextCursor` from one response as the `cursor` query parameter on the next request. Requires the same add/remove-users permission as the PATCH.

## Query parameters

- `cursor` string: Cursor for pagination (from previous response nextCursor)
- `pageSize` integer: Number of results per page (1-100, integer)

## Response `200`

One page of user groups' individual AI credit limits.

- AiCreditControlsUserGroupsListResponse
  - `pageInfo` PageInfo, required
    - `hasNextPage` boolean, required: Whether more results are available
    - `nextCursor` string, nullable, required: Cursor for fetching the next page
    - `pageSize` number, required: Number of results per page
    - `totalRecords` number, required: Total number of records matching the query
  - `records` object[], required: User groups with an individual AI credit limit, ordered by the internal user group id.
    - `creditLimit` number, nullable, required: The user group's individual per-member AI credit limit, or `null` for an explicit unlimited override.
    - `name` string, required: The user group's name.
    - `userGroupId` string, required: The user group ID.

## Other responses

- `400`: Invalid cursor or pageSize.
- `401`: Missing or invalid API key.
- `403`: Insufficient permissions, or per-user-group AI credit limits are not enabled for the organization.

## Changes

- **2026-11-06** `a3246dd072f3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/omniapp/apis/omni-api/changes/api/v1/ai/credit-controls/user-groups/get.md)

---

[API](https://skmtc.dev/omniapp/apis/omni-api.md) - [All operations](https://skmtc.dev/omniapp/apis/omni-api/llms.txt) - [OpenAPI document](https://skmtc.dev/omniapp/apis/omni-api/revisions/a5c0fcf14508?raw)