Skip to navigation
OrganizationsUsage

List Partner Usage

Get a paginated list of raw monthly usage rows for the authenticated partner.

Returns the underlying per-entity monthly usage records that back the /usage/monthly-metrics aggregates. Results are scoped to the authenticated partner’s data; Catena admins may query across partners.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

yearinteger or nullOptional2000-2100

Filter by calendar year (e.g. 2026).

monthinteger or nullOptional1-12

Filter by calendar month (1-12).

entity_typestring or nullOptional

Filter by entity type (e.g. vehicle, driver).

partner_idstring or nullOptionalformat: "uuid"

Filter by partner ID. Admin only — ignored when called by a partner.

cursorstring or nullOptional
Cursor for the next page
sizeintegerOptional1-1000Defaults to 300
Page size

Response

Successful Response
itemslist of objects
totalinteger>=0
current_pagestring or nullOptional
Cursor to refetch the current page
current_page_backwardsstring or nullOptional
Cursor to refetch the current page starting from the last item
previous_pagestring or nullOptional
Cursor for the previous page
next_pagestring or nullOptional
Cursor for the next page

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error