Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Equipment → Get Collection

AI-generated

Summary

Retrieves a list of equipment records from the Rentman API, with optional filtering, sorting, field selection, link expansion, and pagination (all results or a limited page).

Inputs

  • Return All — When true, follows the API's next_page_url to fetch every page. Default false.
  • Limit — Max results to return when Return All is off (min 1, default 50). Sent as the limit query parameter.
  • Offset — Number of results to skip when Return All is off (default 0). Only sent when greater than 0.
  • Filters — Optional collection: Code, Name, Type (normal, set, consumable), In Archive, In Planner, Created After, Modified After, Modified Before, ID Greater Than (for incremental sync), Fields (comma-separated list of fields to return), and Sort (e.g. +name or -modified; default +id).
  • Custom Query Parameters — Arbitrary key/value pairs added to the query string, for field filtering (country=nl) or operators like modified[gt]=2024-01-01.
  • Expand — Comma-separated link fields to inline instead of returning paths, with dot notation up to 3 levels (e.g. equipment,equipment.creator). Listed in the properties, but its display options don't include this operation, so it may not appear in the UI.
  • Request Options — Node settings for batching (items per batch, interval), ignoring SSL issues, proxy, and timeout (default 10000 ms).

Output shape

A list of Rentman equipment records, one per item, with the fields returned by the API (or only those named in Fields).

With Return All enabled, results from all pages are collected. The In Planner filter defaults to true and Type to normal, so unset-looking defaults may narrow results once the Filters collection entry is added. Archived items are excluded unless In Archive is enabled.

Examples

Example 1: Incrementally sync equipment changed since the last run

Return All on; Filters: Modified After = last sync timestamp, Sort = +modified.

Example 2: Find consumables by name

Return All off, Limit 20; Filters: Type = consumable, Name = 'cable', Fields = 'ID,displayname'.

Example 3: Fetch equipment with creator details inline

Return All on; Expand = equipment.creator.

Links

Discussion