Subrents

Get a subrent

Returns the detail of a subrent by its identifier.

Tool

filmo_subrents_get

Readsubrents:read

subrents:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_subrents_get",
    "arguments": {
      "subrentId": "subr_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "type": "bulk",
      "status": "pending",
      "itemId": "item_8f2a1c",
      "itemName": "Example",
      "itemSku": "<itemSku>",
      "quantity": 1,
      "serializedItemId": "seri_8f2a1c",
      "serializedItemCode": "<serializedItemCode>",
      "providerId": "prov_8f2a1c",
      "providerName": "Example",
      "needResolved": true,
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "pickupDate": "2026-09-01T08:00:00Z",
      "returnDate": "2026-09-01T08:00:00Z",
      "orderId": "orde_8f2a1c",
      "projectId": "proj_8f2a1c",
      "purchaseOrderId": "purc_8f2a1c",
      "spaceId": "spac_8f2a1c",
      "notes": "<notes>",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z"
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

Same record as the listing, without what is paid to the supplier.

Arguments

subrentIdstringRequired

Subrent identifier.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique subrent identifier.

typestring

bulk if it is a quantity of a bulk item, serialized if it is a specific unit.

Available options: bulk, serialized

statusstring

Subrent status.

Available options: pending, active, completed, cancelled

itemIdstring

Identifier of the subrented item.

itemNamestring

Name of the subrented item.

itemSkustring | null

Item SKU; null if it has none.

quantitynumber | null

Subrented units; null if it is a specific unit.

serializedItemIdstring | null

Identifier of the specific unit; null if bulk.

serializedItemCodestring | null

Code of the specific unit; null if bulk.

providerIdstring | null

Identifier of the supplier that lends the material; null if not decided yet.

providerNamestring | null

Supplier name; null if not decided yet.

needResolvedboolean

true if the need is already covered, that is, if the supplier and material are confirmed.

startDatestring<date-time> | null

Start of the required period in ISO 8601 UTC; null if not set.

endDatestring<date-time> | null

End of the required period in ISO 8601 UTC; null if not set.

pickupDatestring<date-time> | null

Pickup date from the supplier in ISO 8601 UTC; null if not set.

returnDatestring<date-time> | null

Return date to the supplier in ISO 8601 UTC; null if not set.

orderIdstring | null

Order that motivates the subrent; null if it has none.

projectIdstring | null

Associated project; null if it has none.

purchaseOrderIdstring | null

Purchase order that formalizes it; null if none has been issued.

spaceIdstring | null

Warehouse where the material is received; null if not applicable.

notesstring | null

Subrent notes; null if it has none.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/subrents/{subrentId}.

Subrents
Get a subrent
Returns the detail of a subrent by its identifier.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Get a subrent

Safe writes

Errors