Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Appointment → Get Collection

AI-generated

Summary

Retrieves a list of Appointment records from the Rentman API, either all pages or up to a limit, with optional filtering, sorting, field selection and link expansion.

Inputs

  • Return All — When true, follows the response's next_page_url to fetch every page. Default false.
  • Limit — Max results to return (min 1, default 50). Shown only when Return All is off.
  • Offset — Number of results to skip (default 0). Shown only when Return All is off. Sent only if greater than 0.
  • Filters — Collection of optional filters: Created After (created[gt]), Modified After (modified[gt]), Modified Before (modified[lt]), ID Greater Than (id[gt], useful for incremental sync), Fields (comma-separated list of fields to return), and Sort (e.g. +start or -modified; default +id).
  • Expand — Comma-separated linkable fields to inline instead of returning paths. Supports dot notation up to 3 levels, e.g. equipment,equipment.creator.
  • Custom Query Parameters — Extra key/value query parameters for field-value filtering (e.g. country=nl) or relational operators (e.g. modified[gt]=2024-01-01).
  • Request Options — Node settings for batching (items per batch, interval), ignoring SSL issues, proxy and timeout (default 10000 ms).

Output shape

A list of Appointment records from Rentman, emitted as workflow items.

Fields are limited if Fields is set. Linked fields appear as paths unless expanded via Expand. The source pack contains only stubs, so details come from the declared properties' routing.

Examples

Example 1: Incrementally sync appointments changed since the last run

Return All on; Filters > Modified After set to last run time; Sort -modified.

Example 2: Fetch the 20 most recent appointments with only key fields

Return All off; Limit 20; Filters > Sort -id, Fields: ID,displayname,modified.

Example 3: Get appointments with their equipment details inlined

Return All on; Expand: equipment.

Links

Discussion