Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Project Equipment Group → Get Collection

AI-generated

Summary

Retrieve a collection of Project Equipment Groups from Rentman with optional filters, pagination, field selection, and linked resource expansion.

Inputs

  • Expand — Comma-separated list of related linkable fields to include inline in each returned item instead of as references. Supports up to 3 levels of nested expansion with dot notation (e.g., 'equipment,equipment.creator').
  • Return All — Boolean to specify whether to retrieve all Project Equipment Groups or limit the number of results.
  • Limit — Maximum number of results to return when 'Return All' is false. Defaults to 50.
  • Offset — Number of results to skip for offset-based pagination.
  • Filters — Filters to refine the returned collection, including date filters (created after, modified after/before), ID filters, subproject path, sorting, and selecting specific fields.
  • Custom Query Parameters — Additional user-defined query parameters for field-value filtering or relational operators applied to the collection request.

Output shape

A list of Project Equipment Group records matching the filters and pagination. Each record may include expanded linked fields as specified.

Supports pagination with 'Return All' and 'Limit' options. Expanded fields replace references with inline objects up to 3 nesting levels. Custom filters and query parameters allow fine-grained control of the returned data. Returned fields can be customized with the filters.fields parameter or left empty to return all fields.

Examples

Example 1: Retrieve all Project Equipment Groups with expanded equipment and equipment creator details.

Set 'Return All' to true and 'Expand' to 'equipment,equipment.creator'.

Example 2: Retrieve up to 100 Project Equipment Groups created after 2024-01-01 and sort ascending by ID.

Set 'Return All' to false, 'Limit' to 100, apply filter 'Created After' with date 2024-01-01, and 'Sort' to '+id'.

Links

Discussion