Skip to main content
POST
Read individual user groups' AI credit usage
This total is for information only. A user group’s credit limit applies to each member individually, so Omni doesn’t compare the group total to a limit.Group totals can be more than the organization total, because a member of more than one group counts toward the total of each group. Unlike the Read individual users’ AI credit usage endpoint, this total includes usage by Omni support accounts.

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
userGroupIds
string[]
required

User groups to read usage for, at most 1000 per request. Each entry is a user group's ID. Use the List user groups endpoint to retrieve user group IDs. Each ID must be included only once.

Required array length: 1 - 1000 elements
period
string

UTC calendar month to read, as YYYY-MM. Omit it to read the current billing period. A month after the current one is rejected.

Pattern: ^20\d{2}-(0[1-9]|1[0-2])$
Example:

"2026-09"

Response

Each requested user group's credit usage for the billing period read, in request order.

periodEnd
integer
required

Start of the month after the billing period read, as a Unix ms timestamp (UTC calendar-month boundary, exclusive).

Required range: x >= 0
Example:

1790812800000

periodStart
integer
required

Start of the billing period read, as a Unix ms timestamp (UTC calendar-month boundary).

Required range: x >= 0
Example:

1788220800000

userGroups
object[]
required