AI

List individual users' AI credit limits

Changed on

List the organization's users with an individual monthly AI credit limit, ordered by userId ascending; everyone else follows the org default. Pass limitKind=daily to list users with an individual daily limit instead (requires per-user daily limits to be enabled). Each row has the same shape as the PATCH response: the user's effective limits (null = unlimited) and whether each follows the org default. creditLimit and usesDefaultLimit are always the monthly pair, so with limitKind=daily a user listed only for a daily override shows the org monthly default with usesDefaultLimit: true. Paginated via opaque cursors: pass pageInfo.nextCursor from one response as the cursor query parameter on the next request. Requires the same manage-user-attributes permission as the PATCH.

get/api/v1/ai/credit-controls/users

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/users
  • Auth
    HTTP bearer

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0
pageSizeinteger

Number of results per page (1-100, integer)

Example:20
limitKind'monthly' | 'daily'

Which individual limits to list: monthly (default) lists users with an individual monthly limit; daily lists users with an individual daily limit and requires per-user daily limits to be enabled.

Example:daily

Response

One page of users' individual AI credit limits.

Example response

{
  "records": [
    {
      "creditLimit": 50,
      "dailyCreditLimit": 5,
      "userId": "f4a2b3c8-0d1e-4f5a-9b6c-7d8e9f0a1b2c"
    }
  ]
}

Changes

    • info

      added the new optional query request parameter limitKind

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      endpoint added