Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Contract → Get Collection

AI-generated

Summary

Retrieve a collection of Contract records from Rentman, supporting filtering, sorting, expansion of linked fields, and pagination controls.

Inputs

  • expand — Comma-separated list of linkable fields to inline in the response instead of returning a path. Supports dot notation for nested expansion up to 3 levels (e.g. equipment,equipment.creator). Only item/link fields can be expanded.
  • returnAll — Whether to return all results or limit the number of results.
  • limit — Maximum number of results to return when 'Return All' is false.
  • offset — Number of results to skip for offset-based pagination.
  • filters — Filters to apply on results including 'Created After', 'Fields', 'ID Greater Than', 'Modified After', 'Modified Before', and 'Sort' with direction prefix (+ for ascending, - for descending).
  • customQueryParams — Additional custom query parameters for field filtering or using relational operators such as greater than or less than.

Output shape

a list of Contract records from Rentman matching the specified filters and parameters

Supports pagination if 'Return All' is false; when true, all matching records are returned potentially through multiple paged requests. Expanded linked fields are included inline if specified. Filters and custom query parameters allow precise control over the returned data set.

Links

Discussion