Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Project Function → Get Collection

AI-generated

Summary

Retrieve a collection of Project Function records from Rentman with optional filtering, sorting, field selection, and linked field expansion.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning only their paths. Supports dot notation for nested expansion up to 3 levels (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Boolean to determine whether to return all records or limit the results.
  • Limit — Maximum number of results to return when 'Return All' is false (minimum 1, default 50).
  • Offset — Number of records to skip for offset-based pagination when 'Return All' is false (minimum 0, default 0).
  • Filters — Collection of optional filters to narrow results, such as creation date, modification date, sorting order, selected fields, ID threshold, and project function group path.
  • Custom Query Parameters — Additional custom query parameters for filtering or relational operators not covered by standard filters.

Output shape

a list of project function records matching the specified criteria

Supports pagination when 'Return All' is false; the returned records optionally inline expanded linked/resource fields as specified; all filters and sort options are applied server-side. If no fields filter is specified, all fields are returned by default. Errors are returned on failure.

Examples

Example 1: Retrieve up to 100 Project Functions created after 2023-01-01 and expand the linked 'equipment' field.

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

Links

Discussion