Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Rate → Get Collection

AI-generated

Summary

Retrieve a paginated collection of Rate records with optional filtering, sorting, and expansion of related linked fields.

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 applicable to item/link fields.
  • Return All — Whether to return all Rate records matching the filters or only up to a specified limit.
  • Limit — Maximum number of Rate records to return when not returning all. Default is 50.
  • Offset — Number of Rate records to skip for offset-based pagination.
  • Filters — Optional filters to narrow down Rate records, including 'Created After', 'Modified After', 'Modified Before', 'ID Greater Than', 'Fields' to return, and 'Sort' order.
  • Custom Query Parameters — Additional query parameters for advanced filtering, including relational operators and field-value filters.

Output shape

a paginated list of Rate records based on input filters and expansions

Supports cursor-based pagination with 'Return All' option enabling full collection retrieval. Filter parameters apply as query parameters. The 'Expand' parameter inlines linked fields in the response up to 3 nested levels.

Links

Discussion