API essentials

Pagination & fields

Choose the records and optional fields your integration needs.

Enable pagination explicitly

Vehicle, fleet and fleet-driver lists use a conditional pagination convention:

Input	Behavior
No `page`	Return all accessible matching records
`page=1`	Enable pagination
`per_page=100`	Page size, used with `page`; 100 is the default

No universal maximum page size is specified. Include page to enable pagination; per_page alone does not limit a response.

GET /vehicles?page=1&per_page=100

Vehicle lists are wrapped in devices, fleet lists in fleets, and driver lists in drivers. Paginated responses add Laravel paginator metadata such as current_page, last_page, per_page, total and navigation links. Notification pagination uses a data array instead.

Optional fields

The transformer layer accepts comma-separated includes values. Supported values differ by resource; check each operation in the reference.

GET /vehicles?includes=fleets,tags
GET /fleets?includes=managers
GET /profile?includes=fleets

Some outputs also accept excludes. For travel data, excludes=histories removes the position-history array to reduce response size. Unsupported include/exclude names are not a general filtering language.

Resource-specific filters

Notification lists support after. Fuel history reads start and end. History endpoints have their own day/month/range paths.

There is no universal sorting parameter, search language or cross-resource filter syntax. Use the filters and include combinations documented for each operation, and handle optional provider fields when present.