Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Supplier → Get Collection

AI-generated

Summary

Retrieve a collection of supplier records from Rentman with optional filtering, sorting, pagination, and field expansion.

Inputs

  • Expand — A comma-separated list of linkable fields to inline in the response instead of returning only their paths, supporting up to three levels of nested expansion using dot notation (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Boolean to control whether to return all supplier items or limit the number of results.
  • Limit — Maximum number of supplier records to return when Return All is false (default 50).
  • Offset — Number of supplier records to skip for offset-based pagination when Return All is false.
  • Filters — Filter criteria including contact resource path, creation/modification date ranges, equipment resource path, fields to return, ID greater than a specified number (for incremental sync), and sort order.
  • Custom Query Parameters — Additional custom query parameters for filtering or relational operators not covered by standard filters.

Output shape

a list of supplier objects each containing supplier data fields, optionally expanded linked fields according to the 'Expand' parameter

Supports pagination controlled via 'Return All', 'Limit', and 'Offset' parameters. The 'Expand' field in parameter input controls inlining of related fields in the output. Custom query parameters may refine data returned further.

Examples

Example 1: Retrieve up to 100 suppliers created after Jan 1, 2023, including their related equipment inline.

Set 'Created After' filter to 2023-01-01, 'Limit' to 100, and 'Expand' to 'equipment'.

Example 2: Retrieve all suppliers modified after March 1, 2024, sorted by descending modified date.

Set 'Modified After' filter to 2024-03-01, 'Return All' to true, and 'Sort' to '-modified'.

Links

Discussion