Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Status → Get Collection

AI-generated

Summary

Retrieve a filtered collection of Status records from Rentman with pagination and optional field expansion.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning their references; supports nested expansion up to 3 levels using dot notation (e.g., 'equipment,equipment.creator'). Only item/link fields can be expanded.
  • Return All — Boolean option to return all results without limiting the number of records returned.
  • Limit — Maximum number of Status records to return when not returning all (default 50; minimum 1).
  • Offset — Number of records to skip for offset-based pagination (default 0).
  • Filters — Collection of filters to limit results by creation date, modification date, ID, fields returned, and sort order. Includes: Created After (records created after a specific date), Modified After, Modified Before, ID Greater Than (for incremental sync), and Fields (to specify which fields to return).
  • Custom Query Parameters — Allows adding arbitrary query parameters with field-value filtering or relational operators, supporting advanced filtering on the Status collection.

Output shape

a list of Status records matching the applied filters and pagination parameters

Supports pagination controlled by Return All, Limit, and Offset parameters. The response can include expanded linked fields as specified. Filters and custom query parameters modify the records returned. If Return All is false and no Limit is set, defaults to 50 records.

Examples

Example 1: Fetch all Statuses created after January 1, 2024, including linked equipment and equipment creator data inline

Set 'Filters > Created After' to '2024-01-01T00:00:00Z', set 'Expand' to 'equipment,equipment.creator', and enable 'Return All'.

Example 2: Fetch up to 10 Status records modified before March 1, 2024, skipping the first 5 results

Set 'Filters > Modified Before' to '2024-03-01T00:00:00Z', set 'Limit' to 10, set 'Offset' to 5, and ensure 'Return All' is disabled.

Links

Discussion