Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Factor → Get Collection

AI-generated

Summary

Retrieve a collection of Factor records from Rentman with support for filtering, pagination, sorting, and linked field expansion.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of URLs. Supports nested expansion up to three levels using dot notation (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Boolean flag to return all matching Factor records or limit the results.
  • Limit — Maximum number of Factor records to return when 'Return All' is false. Minimum is 1, default 50.
  • Offset — Number of records to skip for offset-based pagination, must be zero or greater.
  • Filters — Optional filters to narrow results, including date-based filters (Created After, Modified After, Modified Before), field selection, ID thresholds (ID Greater Than), and sorting (e.g., '+id' or '-modified').
  • Custom Query Parameters — Additional custom query parameters for filtering by any field, supporting relational operators (e.g., field[gt]=value).

Output shape

a list of Factor records matching the specified criteria

The response supports pagination controlled by 'Return All', 'Limit', and 'Offset'. Expanded fields inline linked resource data instead of URLs. Filters and sorting affect the returned dataset. Custom query parameters allow flexible API filtering beyond predefined options.

Links

Discussion