Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Supplier → Get File Folders

AI-generated

Summary

Retrieve file folders associated with a specific supplier, optionally applying filters, pagination, field selection, and inline expansion of related linked fields.

Inputs

  • supplierId (required) — The ID of the supplier for which to fetch file folders.
  • expand — Comma-separated list of linked fields to inline in the response instead of returning a path; supports nested expansion up to 3 levels.
  • returnAll — Whether to return all results or only up to a given limit; defaults to false.
  • limit — Maximum number of results to return when 'Return All' is false; minimum 1; defaults to 50.
  • offset — Number of results to skip for offset-based pagination; defaults to 0.
  • filters — Collection of filtering options including contact path, creation and modification date ranges, equipment path, field selection, ID filtering, and sorting preferences.

Output shape

a list of file folder records associated with the specified supplier, structured as JSON objects

Supports pagination controlled via 'returnAll', 'limit', and 'offset' parameters; optional field expansion replaces linked resource paths with inline objects; filter parameters refine the returned dataset based on criteria such as date, related equipment or contacts, and sorting order.

Links

Discussion