Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Factor Group → Get Collection

AI-generated

Summary

Retrieve a collection of Factor Group records from Rentman, optionally filtering, sorting, and paginating the results.

Inputs

  • Expand — Comma-separated list of related fields to inline in the response using dot notation up to 3 levels (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Boolean to decide whether to return all records or limit the result set.
  • Limit — Maximum number of Factor Group records to return when 'Return All' is false.
  • Offset — Number of records to skip for offset-based pagination when 'Return All' is false.
  • Filters — Collection of filtering options including date-based filters (Created After, Modified After, Modified Before), ID threshold, list of fields to return, and sort order.
  • Custom Query Parameters — Additional query parameters supporting field-value filtering or relational operators for advanced queries.

Output shape

a list of Factor Group records

The output supports pagination controlled by 'Return All', 'Limit', and 'Offset' inputs. Expanded linked fields appear inline as specified. Filtering and sorting modify the returned dataset accordingly.

Examples

Example 1: Retrieve all Factor Groups with their related equipment and equipment creators inlined, sorting ascending by ID.

Set 'Return All' to true and 'Expand' to 'equipment,equipment.creator', with 'Sort' set to '+id'.

Links

Discussion