Skip to navigation
API ReferenceUsage

ListUsage

ListUsage pages through the team’s usage per counted limit and period, newest period first: contacts revealed per month or billing year, emails re-validated per month. A period with no usage recorded is not listed; the current period’s usage is also on ListLimits.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

filter.limit_idenumOptional
Only this limit's periods.
Allowed values:
filter.start_time_mindatetimeOptional
Only periods that started at or after this time.
filter.start_time_maxdatetimeOptional
Only periods that started at or before this time.
page_sizeintegerOptional0-100
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=512 characters

Opaque token from a previous response; empty for the first page.

order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

Allowed values:

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.