Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Contact → Get Collection

AI-generated

Summary

Retrieve a collection of contacts from Rentman, applying optional filters, sorting, pagination, and field expansion to customize the returned data.

Inputs

  • Expand — Comma-separated list of linkable fields to inline (expand) in the response, supporting up to 3 levels of nested expansions (e.g., equipment,equipment.creator). Only item/link fields can be expanded.
  • Return All — Whether to return all matching contacts or limit the results to a maximum number.
  • Limit — Maximum number of contacts to return when not returning all.
  • Offset — Number of contacts to skip for offset-based pagination.
  • Filters — Set of optional filters to narrow down the contacts, including Code, Created After, Fields (to return), ID Greater Than, Modified After, Modified Before, Name, Sort (field and direction), and Type (Company, Private, Other).
  • Custom Query Parameters — Additional custom query parameters for filtering contacts, supporting field-value pairs or relational operators like greater than or less than for any supported field.

Output shape

a list of contact records matching the criteria, each including specified or default fields, with expanded linked fields if requested

Supports pagination via 'Return All', 'Limit', and 'Offset' parameters. Filtering accepts both predefined fields and arbitrary query parameters. Expanded fields inline linked resource data instead of just references.

Examples

Example 1: Retrieve all company contacts created after a specific date, expanding related equipment and its creator

Set Type filter to 'company', Created After to the date, Expand to 'equipment,equipment.creator', and Return All to true.

Example 2: Get the first 50 contacts sorted by name ascending

Set Limit to 50, Sort to '+name', and Return All to false.

Links

Discussion