Skip to main content
List your company’s quotas, with filters and pagination. Each quota carries its measurement type (amount / percentage / float), its frequency (monthly / quarterly / semesterly / annually) and whether it is archived. You only see the quotas you have access to. Each quota also lists the views whose id you can pass as view_id to list_quota_values to narrow the rows. Rows are ordered alphabetically by quota name (A→Z).

Parameters

Body

Filter matched against the quota name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the quota id.
boolean
When True, return only archived quotas; otherwise only active (non-archived) quotas.
string
Id of the sandbox to read instead of the live environment — the id list_sandboxes returns. Omit it to read the live environment, the company’s real compensation data, which is the right choice unless the question is explicitly about a sandbox. Only a sandbox id is accepted here — never a sandbox name, and never the live environment’s own id.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this page. Any offset >= 0 is accepted; it does not have to be a multiple of limit, so you can start from an arbitrary row. Pass the next_offset returned by the previous call to walk the pages, or None for the first page.

Response

Body

object[]
integer