Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Serial Number → Get Collection

AI-generated

Summary

Retrieve a collection of serial numbers from Rentman with optional filtering, sorting, pagination, and expansion of linked fields.

Inputs

  • Expand — Specify linked fields as a comma-separated list to include inline in the response instead of as paths; supports nested expansion up to 3 levels using dot notation (e.g., equipment,equipment.creator). Only applicable to item/link fields.
  • Return All — Choose whether to retrieve all results or limit the response to a defined number of items.
  • Limit — Set the maximum number of serial number records to retrieve when not returning all items. Minimum is 1, default is 50.
  • Offset — Skip a specified number of records for offset-based pagination; defaults to 0.
  • Filters — Apply filter criteria such as created after a date, modified date ranges, ID greater than a value, which fields to return, and sorting order with direction indicated by prefix (+ for ascending, - for descending).
  • Custom Query Parameters — Add arbitrary query parameters for additional filtering or relational operators, such as field-value pairs or expressions like modified[gt]=2024-01-01.

Output shape

a list (collection) of serial number records

Supports pagination when Return All is false, using Limit and Offset parameters. Expanded linked fields are inlined in each record as specified. Filtering and sorting parameters refine and order the result set. If pagination is enabled, multiple requests may be executed to collect all data.

Examples

Example 1: Get up to 100 serial numbers created after Jan 1, 2024, including inline equipment details and sorted by modified date descending.

Set Return All to false, Limit to 100, Created After filter to 2024-01-01, Expand to 'equipment', and Sort to '-modified'.

Links

Discussion