Skip to main content
List one quota’s target values across users and periods, with pagination. Resolve a single quota, then return its per-user, per-period target values. The quota’s type and frequency are surfaced once in the quota header; each row carries value, the owning user_email, the period (big-endian, at the quota’s frequency), and currency only when the quota is amount-typed. Pair with list_quotas to find the quota first. Filters combine with AND. You only see quotas and values you have access to; a quota you can’t access is reported as not found. Pass view to narrow to a single view’s rows. Rows are ordered by period ascending (earliest first), then by user.

Parameters

Body

quota
string
required
The quota to read values from. A case- and accent-insensitive substring of the quota name, or its ObjectId. Must resolve to exactly one quota — an ambiguous name that matches several is rejected with a clear error asking you to refine it.
period
string
Single period, in the quota’s own frequency format: YYYY-MM (monthly), YYYY-QX (quarterly), YYYY-SX (semesterly) or YYYY (annually). A period in the wrong format for this quota’s frequency is rejected with the expected format. Omitted: values for every period.
User filter — a name/email substring or an ObjectId, matched the same way as list_users search. Omitted: every user you can see. (Named user_search because user is reserved for the authenticated caller.)
view
string
Quota view to apply, by name (case- and accent-insensitive substring) or ObjectId. Restricts the rows to the users that view exposes. Omitted: every user you can see.
limit
integer
Page size, between 1 and 250. Defaults to 50.
offset
integer
Row offset into the result set — the number of rows to skip before this page. Pass the next_offset returned by the previous call, or None for the first page.

Response

Body

quota
object
values
object[]
next_offset
integer