Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Task → Get Collection

AI-generated

Summary

Retrieve a collection of Task records from Rentman with optional filtering, pagination, field selection, sorting, and expansion of linked fields.

Inputs

  • expand — Comma-separated list of linked fields to expand inline in the response. Supports dot notation for nested expansion up to 3 levels (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • returnAll — Boolean to decide whether to return all available results or limit to a specified number.
  • limit — Maximum number of Task records to return when returnAll is false. Minimum 1.
  • offset — Number of records to skip for offset-based pagination. Minimum 0.
  • filters — Set of optional filters including Created After, Modified After, Modified Before dates, ID Greater Than, Fields to return, and Sort order.
  • customQueryParams — Additional custom query parameters for advanced filtering or relational operators, specified as key-value pairs.

Output shape

a collection (list) of Task records, each containing the requested fields and optionally expanded linked items.

Supports pagination if returnAll is false with limit and offset parameters; expanded fields appear inline up to three levels deep. Filters and custom query parameters refine the returned Task records.

Examples

Example 1: Fetch all Task records created after 2024-01-01 with equipment details expanded inline.

Set 'created_gt' filter to 2024-01-01 and 'expand' to 'equipment' with returnAll enabled.

Example 2: Retrieve up to 100 Task records sorted by descending modification date, including only 'id', 'displayname', and 'modified' fields.

Set 'returnAll' to false, 'limit' to 100, 'sort' to '-modified', and 'fields' to 'id,displayname,modified'.

Links

Discussion