Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Contract → Get

AI-generated

Summary

Retrieve a contract by its ID from Rentman, optionally expanding linked fields inline up to three nested levels.

Inputs

  • Contract ID (required) — The ID of the contract to retrieve.
  • Expand — Comma-separated list of linked fields to inline in the response instead of returning their paths. Supports dot notation for nested expansion up to 3 levels, e.g., 'equipment,equipment.creator'.

Output shape

a single contract record with fields as returned by the Rentman API, optionally including expanded linked objects inline

The output includes the contract data under the response structure returned by Rentman. Expanded fields are replaced inline if specified. Errors or missing IDs may cause failure. Supports optional standard request options like batching, proxy, timeout, and SSL handling.

Examples

Example 1: Get a contract with ID '12345' without expansions

Set Contract ID to '12345' and leave Expand empty.

Example 2: Get a contract with expanded equipment and its creator

Set Contract ID to '12345' and Expand to 'equipment,equipment.creator'.

Links

Discussion