Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

File Folder → Get Collection

AI-generated

Summary

Retrieve a list of file folder records from the Rentman system applying optional filters and query parameters.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning a path. Supports dot notation for up to 3 levels for nested expansions (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Filters — Collection of filter options to narrow down results, including created after, modified after/before, ID greater than, and sorting options.
  • Custom Query Parameters — Additional custom key-value pairs for filtering or relational operators to apply on the query string.
  • Return All — Boolean flag to determine whether to return all matching results or limit the number returned.
  • Limit — Maximum number of file folder records to return if 'Return All' is false.
  • Offset — Number of records to skip for offset-based pagination when limiting results.

Output shape

a collection (list) of file folder objects matching the specified filters and expansions

Supports pagination if 'Return All' is false, controlled via 'Limit' and 'Offset'. Expanded fields are included inline in the response as specified. Filtering supports standard Rentman file folder fields and custom query parameters for advanced querying.

Links

Discussion