Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

File → Get Collection

AI-generated

Summary

Retrieve a collection of file records from Rentman with optional filtering, pagination, field selection, and inline expansion of linked fields.

Inputs

  • Expand — Comma-separated list of linkable fields to inline (expand) in the response instead of returning just a path; supports nested expansion up to 3 levels using dot notation (e.g., equipment,equipment.creator). Only applicable to item/link fields.
  • Return All — Boolean flag to return all matching results or limit to a specific number (default is false).
  • Limit — Maximum number of results to return if "Return All" is false; minimum value is 1, default is 50.
  • Offset — Number of results to skip for offset-based pagination; applicable only if "Return All" is false.
  • Filters — Filter criteria including creation or modification dates, ID greater than a value, specific fields to return, and sort order. Filters help limit the returned collection based on properties like created_after, modified_after/before, id greater than, and sorting order (+ or - prefix).
  • Custom Query Parameters — Additional custom query parameters for filtering, supporting field-value filtering or relational operators (e.g., modified[gt]=2024-01-01).
  • Request Options — Advanced request options such as batching, SSL certificate override, proxy, and timeout settings.

Output shape

A list of file records matching the specified filters and pagination parameters, with requested fields and expanded linked items inline as specified.

Pagination supports offset and limit when "Return All" is false; if "Return All" is true, all matching records are fetched via automatic pagination. The "Expand" field allows embedding related records inline up to 3 nested levels, improving workflow data richness. Custom query parameters extend filtering capabilities beyond predefined filters.

Links

Discussion