Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Supplier → Get For Equipment

AI-generated

Summary

Retrieve supplier records linked to a specific equipment item in Rentman, optionally filtering and expanding related linked fields.

Inputs

  • equipmentId (required) — The ID of the equipment item whose linked suppliers are to be retrieved.
  • expand — Comma-separated list of linked fields to expand inline in the response, supporting nested expansion up to 3 levels.
  • returnAll — Toggle to return all matching results or limit the number of records returned.
  • limit — Maximum number of supplier records to retrieve, applicable when not returning all results.
  • offset — Number of records to skip for pagination, applicable when not returning all results.
  • filters — Optional filters to narrow down which suppliers are returned, including contact path, creation/modification dates, and sorting options.

Output shape

a list of supplier objects linked to the specified equipment item

Supports pagination via 'returnAll', 'limit', and 'offset' fields. Filter options can refine results. Expanded linked fields appear inline as per the 'expand' parameter. Errors related to invalid equipment ID or permissions will be returned as error responses.

Examples

Example 1: Fetch all suppliers linked to equipment ID '12345', expanding the creator of each equipment record.

Set 'equipmentId' to '12345', 'returnAll' to true, and 'expand' to 'equipment.creator'.

Example 2: Fetch up to 10 suppliers linked to equipment ID '12345' created after January 1, 2023, sorted by ascending ID.

Set 'equipmentId' to '12345', 'returnAll' to false, 'limit' to 10, and filter 'created_gt' to '2023-01-01', with 'sort' set to '+id'.

Links

Discussion