Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Factor → Get

AI-generated

Summary

Retrieve a single factor by its ID from the Rentman system, optionally expanding linked fields in the response using dot notation for nested data.

Inputs

  • Factor ID (required) — The unique identifier of the factor to retrieve.
  • Expand — Comma-separated list of linkable fields to include inline in the response instead of returning a resource path; supports nested expansion up to three levels (e.g., equipment,equipment.creator).

Output shape

a single factor record as returned by the Rentman API, including any expanded linked fields as requested

The response shape depends on the Rentman API for factors and includes expanded linked fields if specified. No pagination applies since only a single factor is retrieved. Errors if the factor ID is invalid or not found.

Examples

Example 1: Get a factor by its ID

Set 'Factor ID' to the target factor's ID, optionally set 'Expand' to include linked equipment or other fields.

Links

Discussion