Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Vehicle → Get Collection

AI-generated

Summary

Retrieve a paginated collection of vehicles from the Rentman system, applying optional filters, sorting, and field expansions to customize the returned data.

Inputs

  • Expand — Comma-separated list of linked fields to inline in the response (supports up to 3 levels of nesting with dot notation). Only item/link fields can be expanded.
  • Return All — Boolean to decide whether to return all results or limit the number of results returned.
  • Limit — Maximum number of vehicle records to return when not returning all. Minimum is 1.
  • Offset — Number of results to skip for offset-based pagination (minimum 0).
  • Filters — Optional filters to narrow returned vehicles by creation date, modification date, ID, fields to return, and sorting order.
  • Custom Query Parameters — Additional key-value pairs to filter or modify the API query, supporting relational operators and field-value filtering.
  • Request Options — Optional settings for HTTP request such as batching, timeout, proxy, and SSL certificate validation.

Output shape

a paginated list of vehicle records, each optionally expanded with linked fields as requested

Supports pagination via 'limit' and 'offset' or the 'returnAll' flag which exhaustively fetches all pages. Filters and sorting affect the API query to refine or order the returned collection. Expanded fields inline linked resources instead of returning references.

Links

Discussion