Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Alternative → Get Collection

AI-generated

Summary

Retrieve a collection of Alternative records from Rentman, supporting filtering, sorting, pagination, and optional expansion of linked fields.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning a path. Supports up to 3 levels of nested expansion using dot notation (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Whether to return all matching results or limit the number of results returned.
  • Limit — Maximum number of results to return if 'Return All' is false.
  • Offset — Number of results to skip for offset-based pagination if 'Return All' is false.
  • Filters — Filter the collection by criteria including creation date, modification date, equipment resource path, ID (greater than), and specifying fields to return. Also supports sorting by specified fields with direction prefix (+ for ascending, - for descending).
  • Custom Query Parameters — Additional custom query parameters for field-value filtering or relational operators (e.g. country=nl, modified[gt]=2024-01-01).
  • Request Options — Options such as batching, SSL validation toggling, HTTP proxying, and request timeout settings.

Output shape

a list of Alternative records

Supports automatic pagination when 'Return All' is enabled. The response includes detailed fields filtered per user request and optionally expanded linked objects. Errors and response envelopes follow Rentman API standards.

Examples

Example 1: Fetch all Alternatives created after January 1, 2024, expanded to include related equipment and the equipment's creator.

Set 'Return All' to true, set 'Filters' with 'Created After' date of 2024-01-01, and 'Expand' to 'equipment,equipment.creator'.

Links

Discussion