Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Project → Get Collection

AI-generated

Summary

Retrieve a filtered and optionally paginated list of projects from Rentman, supporting field selection, sorting, and expansion of related entities.

Inputs

  • Expand — Comma-separated list of linkable fields to include inline in the response, supporting up to three levels of nested expansion using dot notation (e.g., 'equipment,equipment.creator'). Only applicable to item/link fields.
  • Return All — Boolean to specify whether to return all matching projects or limit the count.
  • Limit — If 'Return All' is false, specifies the maximum number of projects to return.
  • Offset — Number of projects to skip, used for offset-based pagination.
  • Filters — Set of optional filters including created after date, modified after/before dates, project name, project number, ID greater than a value, fields to return, and sort order.
  • Custom Query Parameters — Additional arbitrary query parameters for field-value filtering or relational operators, allowing advanced filtering not covered by default filters.

Output shape

a list of project records matching the specified filters and pagination parameters, with fields included as specified and optionally expanded linked entities

Supports pagination via 'Return All', 'Limit', and 'Offset'. Expansions inline related entities up to three nested levels. Custom filters allow extra query parameters. Results follow Rentman's API response format for projects.

Examples

Example 1: Fetch first 10 projects created after 2023-01-01 including expanded equipment and equipment.creator details.

Set 'Created After' filter to '2023-01-01', 'Limit' to 10, and 'Expand' to 'equipment,equipment.creator'.

Links

Discussion