Subrents

Get a subrent

Returns the detail of a subrent by its identifier.

GET

/api/v1/subrents/{subrentId}

curl https://app.filmo.io/api/v1/subrents/subr_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/subrents/subr_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/subrents/subr_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "subrent_9f3a2b",
    "type": "bulk",
    "status": "pending",
    "itemId": "item_9f3a2b",
    "itemName": "Example item name",
    "itemSku": "Example item sku",
    "quantity": 1,
    "serializedItemId": "serialized_item_9f3a2b",
    "serializedItemCode": "Example serialized item code",
    "providerId": "provider_9f3a2b",
    "providerName": "Example provider name",
    "needResolved": true,
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "pickupDate": "2026-09-01T08:00:00.000Z",
    "returnDate": "2026-09-01T08:00:00.000Z",
    "orderId": "order_9f3a2b",
    "projectId": "project_9f3a2b",
    "purchaseOrderId": "purchase_order_9f3a2b",
    "spaceId": "space_9f3a2b",
    "notes": "Example text.",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "subrents:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

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

Authorizations

Bearer API key with the scope below. subrents:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

subrentIdstringRequired

Subrent identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: SubrentDto

Envelope: SubrentResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Material rented from another company to cover a job. It does NOT include what is paid to the supplier: crossing it with the sale price of the line would give the exact margin.

Show child attributes

data.idstring

Unique subrent identifier.

data.typestring

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

Available options: bulk, serialized

data.statusstring

Subrent status.

Available options: pending, active, completed, cancelled

data.itemIdstring

Identifier of the subrented item.

data.itemNamestring

Name of the subrented item.

data.itemSkustring | null

Item SKU; null if it has none.

data.quantitynumber | null

Subrented units; null if it is a specific unit.

data.serializedItemIdstring | null

Identifier of the specific unit; null if bulk.

data.serializedItemCodestring | null

Code of the specific unit; null if bulk.

data.providerIdstring | null

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

data.providerNamestring | null

Supplier name; null if not decided yet.

data.needResolvedboolean

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

data.startDatestring<date-time> | null

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

data.endDatestring<date-time> | null

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

data.pickupDatestring<date-time> | null

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

data.returnDatestring<date-time> | null

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

data.orderIdstring | null

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

data.projectIdstring | null

Associated project; null if it has none.

data.purchaseOrderIdstring | null

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

data.spaceIdstring | null

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

data.notesstring | null

Subrent notes; null if it has none.

data.createdAtstring<date-time>

Creation date in ISO 8601 UTC.

data.updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Rentals
Subrent
Material rented from another company to cover a job.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Subrent