Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Contact Person → Get Collection

AI-generated

Summary

Retrieve a filtered and optionally paginated collection of Contact Person records from the Rentman API, with customizable field selection, sorting, and nested expansion of linked resources.

Inputs

  • expand — Comma-separated list of linkable fields to inline in the response instead of returning a path. Supports up to 3 levels of nested expansion using dot notation (e.g. equipment,equipment.creator). Only item/link fields can be expanded.
  • returnAll — Whether to return all results matching the query or only up to a specified limit.
  • limit — Max number of results to return when 'Return All' is false; minimum is 1. Defaults to 50.
  • offset — Number of results to skip for offset-based pagination; used only when 'Return All' is false.
  • filters — Collection of filter conditions to narrow the returned Contact Persons, including: filtering by contact path, created after date, modified after/before dates, id greater than specified, fields to return, and sort order.
  • customQueryParams — Additional custom query parameters to filter or modify results using field-value pairs or relational operators (e.g. country=nl or modified[gt]=2024-01-01).
  • requestOptions — Node-level request configuration such as batching, ignoring SSL issues, proxy settings, and request timeout.

Output shape

a list of Contact Person records matching the applied filters and pagination settings, optionally with nested linked fields expanded inline according to the 'Expand' parameter.

Supports offset-based pagination when 'Return All' is false and automatic pagination to retrieve all pages when 'Return All' is true. The 'Fields' filter limits which fields are included for each Contact Person. Expansion of linked fields can include nested expansions up to three levels deep. Custom query parameters allow advanced filtering beyond built-in options.

Examples

Example 1: Get up to 100 Contact Persons created after January 1, 2024, sorting by descending modification date and expanding related equipment creators inline.

Set 'Return All' to false, 'Limit' to 100, under filters set 'Created After' to 2024-01-01, set 'Sort' to '-modified', and 'Expand' to 'equipment.creator'.

Links

Discussion