Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Alternative → Get For Equipment

AI-generated

Summary

Retrieve alternatives associated with a specified equipment item, optionally filtering, paginating, and expanding related linked fields in the response.

Inputs

  • Equipment ID (required) — The ID of the equipment item whose alternatives are to be retrieved.
  • Expand — Comma-separated list of linkable fields to inline/explode in the response instead of returning just a reference path. Supports nested expansion up to 3 levels, e.g. 'equipment,equipment.creator'.
  • Return All — Boolean indicating whether to return all available results or limit the output.
  • Limit — Maximum number of alternative records to return when 'Return All' is false.
  • Offset — Number of results to skip for offset-based pagination, applicable when 'Return All' is false.
  • Filters — Collection of filter criteria to narrow results, including created/modified date ranges, ID greater than, specific equipment resource path, requested fields, and sorting order.

Output shape

a list of alternative records related to the specified equipment, including any requested expanded linked fields

Supports pagination controlled via 'Return All', 'Limit', and 'Offset' parameters. Filters control result set and returned fields. Expanded fields replace reference paths with inline object data up to 3 nested levels.

Examples

Example 1: Retrieve all alternatives for equipment ID 123 with full details expanded for 'equipment' and 'equipment.creator'

Set Equipment ID to '123', Enable Return All, Set Expand to 'equipment,equipment.creator'.

Example 2: Retrieve the first 20 alternatives created after January 1, 2023, sorted by ascending ID

Set Equipment ID, Return All false, Limit 20, Filters 'Created After' to '2023-01-01', Sort set to '+id'.

Links

Discussion