Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Invitation → Get Collection

AI-generated

Summary

Retrieve a collection of Invitation records from Rentman, optionally applying filters, pagination, sorting, and field expansions.

Inputs

  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning a reference path. 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 flag to return all matching Invitations or limit the results to a specified number.
  • Limit — Maximum number of Invitation records to return when 'Return All' is false.
  • Offset — Number of Invitation records to skip for offset-based pagination.
  • Filters — A set of filter parameters to restrict returned Invitations by creation date, modification date, ID, fields to return, and sorting order.
  • Custom Query Parameters — Additional custom query parameters for field-value filtering or relational operations.

Output shape

a list of Invitation records, each possibly containing expanded linked fields as requested

Results will respect pagination settings, filters, and expansions. The output is enveloped in the standard API response structure and contains only the requested fields if specified.

Links

Discussion