Skip to main content
GET
List Partner Usage

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

year
integer | null

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

Required range: 2000 <= x <= 2100
month
integer | null

Filter by calendar month (1-12).

Required range: 1 <= x <= 12
entity_type
string | null

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

partner_id
string<uuid> | null

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

cursor
string | null

Cursor for the next page

size
integer
default:300

Page size

Required range: 1 <= x <= 1000

Response

Successful Response

items
PartnerMonthlyUsageRead · object[]
required
total
integer
required
Required range: x >= 0
current_page
string | null

Cursor to refetch the current page

current_page_backwards
string | null

Cursor to refetch the current page starting from the last item

previous_page
string | null

Cursor for the previous page

next_page
string | null

Cursor for the next page