Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Project Function Group → Get Collection

AI-generated

Summary

Retrieve a paginated collection of Project Function Group records from Rentman with optional filters, sorting, field selection, and expansion of linked fields.

Inputs

  • Expand — Comma-separated list of linkable fields to inline (expand) in the response instead of just returning their path. Supports up to 3 levels of nested expansion using dot notation, e.g., 'equipment,equipment.creator'.
  • Return All — Boolean to determine whether to return all matching records or limit the number of results.
  • Limit — Maximum number of results to return when 'Return All' is false. Minimum is 1, default is 50.
  • Offset — Number of results to skip for offset-based pagination; defaults to 0.
  • Filters — Filters to narrow the returned Project Function Groups, including creation and modification date ranges, ID greater than a value, sorting order, specific fields to return, and filtering by subproject resource path.
  • Custom Query Parameters — Additional arbitrary query parameters for filtering using field-value pairs or relational operators (e.g., 'modified[gt]=2024-01-01').
  • Request Options — Technical request options including batching configuration, SSL certificate validation behaviour, proxy settings, and request timeout.

Output shape

a list of Project Function Group objects matching the query parameters

Supports pagination when 'Return All' is false and 'Limit' and 'Offset' are specified. When 'Return All' is true, iterates through paginated endpoints to retrieve all records. The 'Expand' parameter enables inline expansion of linked fields (only item/link fields). Returned data fields can be limited via the 'Fields' filter. Custom query parameters allow advanced filtering. Errors or empty responses depend on upstream API behaviour.

Links

Discussion