Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Stock Location → Get Collection

AI-generated

Summary

Retrieve a paginated collection of Stock Locations from Rentman, applying optional filters, pagination, and field expansion.

Inputs

  • expand — Comma-separated list of linkable fields to inline in the response instead of returning a path; supports up to 3 levels of nested expansion using dot notation (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • returnAll — Boolean flag to return all Stock Locations without limit if set to true; otherwise, limits the results to the specified 'Limit'.
  • limit — Maximum number of Stock Location records to return when 'Return All' is false; minimum 1, default 50.
  • offset — Number of Stock Location records to skip for offset-based pagination, default 0.
  • filters — Filtering options including 'Created After', 'Modified After', 'Modified Before', 'ID Greater Than', 'Fields' to return, and 'Sort' order.
  • customQueryParams — Custom query parameters to add field-value filtering or relational operators beyond the standard filters.

Output shape

a list of Stock Location records

The response supports pagination controlled by 'returnAll', 'limit', and 'offset'. Expanded linked fields replace their usual path with inline data. Filters and customQueryParams refine the query, and only the fields requested are returned if specified.

Links

Discussion