Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

File → Get

AI-generated

Summary

Retrieve detailed information about a specific file by its ID from Rentman, optionally inlining related resources by specifying expandable fields.

Inputs

  • File ID (required) — The ID of the file to retrieve.
  • Expand — Comma-separated list of linkable fields to inline in the response instead of returning a reference path. Supports up to 3 levels of nested expansion using dot notation (e.g., equipment,equipment.creator). Only item/link fields can be expanded.

Output shape

a single JSON object representing the requested file, including any expanded linked fields as specified

If 'Expand' is specified, the response includes nested inline resources for the linkable fields provided, up to three levels deep. If not specified, linked fields will contain only paths or identifiers. Errors will be returned if the File ID is invalid or access fails.

Examples

Example 1: Retrieve a file with ID '12345' including expansion of related equipment and the equipment's creator.

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

Example 2: Retrieve a file with ID '67890' without expanding any linked fields.

Set 'File ID' to '67890' and leave 'Expand' empty.

Links

Discussion