Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Folder → Get Collection

AI-generated

Summary

Retrieve a collection of folders from Rentman with optional filters, pagination, field selection, custom query parameters, and expandable linked fields.

Inputs

  • expand — Comma-separated list of linkable fields to inline in the response instead of returning only a path. Supports nested expansion up to 3 levels using dot notation.
  • returnAll — Boolean indicating whether to return all results or limit the number of results returned (default false).
  • limit — Maximum number of folder records to return when returnAll is false. Minimum value 1; defaults to 50.
  • offset — Number of results to skip for offset-based pagination. Minimum value 0; defaults to 0.
  • filters — Collection of optional filters including created_after, modified_after, modified_before, id greater than a value, fields to return, and sort direction.
  • customQueryParams — Custom key-value query parameters for additional filtering, supporting relational operators (e.g. modified[gt]=2024-01-01).

Output shape

a list of folder records matching the specified filters and pagination parameters, with fields expanded as requested.

Supports pagination when returnAll is false using limit and offset parameters; otherwise returns all available folders. Expand parameter allows inline expansion of linked item fields up to three nested levels.

Links

Discussion