Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Project Crew → Get Collection

AI-generated

Summary

Retrieve a paginated collection of Project Crew records from Rentman with optional filtering, sorting, field selection, and inline expansion of linked fields.

Inputs

  • Expand — Comma-separated list of linkable fields to expand inline in the response instead of returning only a path. Supports up to three levels of nested expansion (e.g., equipment,equipment.creator).
  • Return All — Boolean flag to determine if all matching records should be retrieved or limited to a specified number.
  • Limit — Maximum number of results to return when not returning all records; minimum is 1, default 50.
  • Offset — Number of results to skip for offset-based pagination, default is 0.
  • Filters — Collection of filters including Created After, Modified After/Before, ID Greater Than, Sort order, Project Function path, and specific fields to return. These translate into respective query parameters for restricting the returned dataset.
  • Custom Query Parameters — Allows adding arbitrary key-value pairs as query parameters for additional filtering or relational operators not covered by standard filters.

Output shape

a list of Project Crew records, potentially paginated depending on parameters

The returned data can include expanded linked item fields as specified. Pagination is controlled by Return All, Limit, and Offset parameters. Filters and custom query parameters allow fine-grained control of which records are returned.

Examples

Example 1: Fetch all Project Crew entries expanded to include related equipment and equipment creator information, retrieving all available results.

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

Example 2: Retrieve the first 20 Project Crew records created after January 1, 2024, returning only the ID and displayname fields.

Set Limit to 20, Filter 'Created After' to 2024-01-01, and Fields to 'ID,displayname'.

Links

Discussion