Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Invitation → Get

AI-generated

Summary

Retrieve detailed information about a specific invitation by its ID, optionally expanding linked fields in the response for deeper data insight.

Inputs

  • Invitation ID (required) — The unique identifier of the invitation to retrieve.
  • Expand — Comma-separated list of linkable fields to inline within the response instead of their reference paths. Supports nested expansion up to three levels using dot notation (e.g., equipment,equipment.creator). Only item or link fields can be expanded.

Output shape

a single invitation record object

The response may include inline expanded linked fields as specified by the 'Expand' input. Errors or missing invitations will return appropriate error information. No pagination applies since a single item is retrieved.

Examples

Example 1: Get an invitation's basic information by ID

Specify the 'Invitation ID' corresponding to the target invitation, leave 'Expand' empty to retrieve the default data.

Example 2: Get an invitation with expanded related equipment and its creator

Set 'Invitation ID' to the target invitation's ID and 'Expand' to 'equipment,equipment.creator' to inline the linked equipment data and its creator details.

Links

Discussion