Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Subproject → Get Collection

AI-generated

Summary

Retrieve a collection of subprojects from Rentman, optionally filtering, sorting, paginating, and expanding linked fields.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning their path. Supports dot notation for nested expansion up to 3 levels (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Whether to return all results or limit the number of returned subprojects.
  • Limit — Maximum number of subprojects to return if not returning all.
  • Offset — Number of subprojects to skip for offset-based pagination.
  • Filters — Optional filters to apply on subprojects, including creation and modification date boundaries, ID thresholds, parent project path, field selection, and sort order.
  • Custom Query Parameters — Additional custom query parameters for fine-grained filtering or relational operators.

Output shape

A list of subproject records matching the applied filters and pagination.

Supports pagination controlled by 'Return All', 'Limit', and 'Offset'. The 'Expand' input can inline linked resources up to 3 levels deep. Filters affect the query parameters sent to the API and refine results returned accordingly.

Examples

Example 1: Get up to 100 subprojects created after January 1, 2024, with expanded equipment data

Set 'Created After' filter to 2024-01-01, 'Limit' to 100, and 'Expand' to 'equipment'.

Links

Discussion