Vehicle

Get vehicles

List the authenticated company's vehicles, oldest first (by creation time, ascending). Only vehicles owned by the API key's company are returned; soft-deleted vehicles are omitted. Narrow the result with the inserted_datetime and updated_datetime range filters, or omit them to return the full set, paginated.

Results are paged; follow next_page in the response envelope until it is null to walk every page.

Required permission: settings_permissions_vehicles.

get/public/v1/vehicles

Query parameters

idsstring[]

Restrict the result to specific vehicles by ID (the same ID returned as each vehicle's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.

inserted_datetimestring

Filter to vehicles by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.

updated_datetimestring

Filter to vehicles by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.

pagestring

Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.

Response

A list of vehicles

Changes

No recorded changes to this endpoint across all 1 revision of this API.