HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Usage states / Listing

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Get the current usage state of every driver, partner and roaming eMSP, newest record first: drivers by descending userId, partners by descending partnerId and roaming eMSPs by descending roamingEmspId, merged into one list. Usage states are recalculated every night and listed only for operators with churn insights enabled. Deleted or disabled drivers and partners without a state are not listed, and neither is a roaming eMSP without a state yet.

filter[updatedAfter] matches rows whose updatedAt is at or after the given time: the state, stateStartedOn or reason changed. updatedAt lists what counts as a change; the nightly refresh of the figures does not. The first nightly run after the release of this resource stamps every row, so the first pull with filter[updatedAfter] after it returns every row.

A driver or partner that loses its usage state (deleted, disabled, excluded from churn insights, a partner below the minimum number of drivers or in Offboarding) disappears from the listing, and filter[updatedAfter] does not return it. Clients that keep a copy must reconcile it with a periodic full pull without filter[updatedAfter].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object
integer
1 to 100
Defaults to 100

The number of items to return per page.

string

The cursor to fetch the next page.

Do not construct this value manually. Use one of the following methods:

  • Use the value from the previous response's links.next to fetch the next page
  • Pass an empty string (e.g., ?cursor or ?cursor=) to initiate cursor pagination on the first page
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json