Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Leave Mutation → Get Collection

AI-generated

Summary

Retrieves a collection of Leave Mutation records from the Rentman API, with optional filtering, sorting, field selection, link expansion, and pagination.

Inputs

  • Return All — If true, follows next_page_url to fetch every page of results. Default false.
  • Limit — Max number of results 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: Created After (created[gt]), Crew Member path such as /crew/42, Fields (comma-separated fields to return), ID Greater Than (id[gt], useful for incremental sync), Modified After (modified[gt]), Modified Before (modified[lt]), and Sort (default -created; use + or - prefix).
  • Custom Query Parameters — Arbitrary key/value query parameters for field filtering (e.g. country=nl) or relational operators (e.g. modified[gt]=2024-01-01).
  • Expand — Comma-separated linkable fields to inline instead of returning paths. Supports dot notation up to 3 levels (e.g. equipment,equipment.creator). Only item/link fields can be expanded. Its display options list other operations, so it may not appear for this one 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 Leave Mutation records from the Rentman API, returned as the response data for the collection.

With Return All off, results are limited by Limit and Offset. With Return All on, pagination follows next_page_url until it is absent. The Fields filter limits which properties appear in each record. Expanded links are inlined only if Expand is applied.

Examples

Example 1: Incrementally sync leave mutations for new records

Return All = true; Filters: ID Greater Than = last stored ID, Sort = +ID.

Example 2: Get recent changes for one crew member

Filters: Crew Member (Path) = /crew/42, Modified After = a date; Limit = 100.

Links

Discussion