list_quotas - Qobra public API documentation

Parameters

Body

string

Filter matched against the quota name (case- and accent-insensitive substring) or, when it is a valid ObjectId, against the quota id.

archived

boolean

When True, return only archived quotas; otherwise only active (non-archived) quotas.

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

quotas

object[]

Show object properties

string

resource_url

string

Deep link to open this quota in the Qobra web app.

name

string

description

string

type

string

Unit of the target value: amount (monetary, has a currency), percentage, or float (plain number). One of: amount, percentage, float.

frequency

string

currency_type

string

The quota’s default currency for amount targets: ‘company’ (the company currency), ‘user’ (each user’s payment currency) or ‘calculation’ (the user’s calculation currency). A target value that carries its own currency overrides this default. Only meaningful for amount quotas. One of: company, user, calculation.

archived

boolean

views

object[]

The quota views the caller may query for this quota’s values — pass one as view to list_quota_values to narrow the rows. Empty when no view is relevant.

Show object properties

string

name

string

next_offset

integer

​Parameters

​Response

Parameters

Response