*REST API › Endpoint reference › Rentals › Subrents*

# Get a subrent

> Returns the detail of a subrent by its identifier.

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

`GET /api/v1/subrents/{subrentId}` — scope `subrents:read`

Scope: `subrents:read` · 120/min · Strict tenancy · If-None-Match · MCP: `filmo_subrents_get`

## Authorizations

Bearer API key with the scope below. `subrents:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `subrentId` | string | Yes | Subrent identifier. |

## Request examples

*Get a subrent*

**cURL**

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

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/subrents/subr_8f2a1c', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

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

## Response

Response schema: `SubrentDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | 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. |
| `data.id` | string | Unique subrent identifier. |
| `data.type` | string | bulk if it is a quantity of a bulk item, serialized if it is a specific unit. `bulk`, `serialized` |
| `data.status` | string | Subrent status. `pending`, `active`, `completed`, `cancelled` |
| `data.itemId` | string | Identifier of the subrented item. |
| `data.itemName` | string | Name of the subrented item. |
| `data.itemSku` | string | Item SKU; null if it has none. |
| `data.quantity` | number | Subrented units; null if it is a specific unit. |
| `data.serializedItemId` | string | Identifier of the specific unit; null if bulk. |
| `data.serializedItemCode` | string | Code of the specific unit; null if bulk. |
| `data.providerId` | string | Identifier of the supplier that lends the material; null if not decided yet. |
| `data.providerName` | string | Supplier name; null if not decided yet. |
| `data.needResolved` | boolean | true if the need is already covered, that is, if the supplier and material are confirmed. |
| `data.startDate` | string<date-time> | Start of the required period in ISO 8601 UTC; null if not set. |
| `data.endDate` | string<date-time> | End of the required period in ISO 8601 UTC; null if not set. |
| `data.pickupDate` | string<date-time> | Pickup date from the supplier in ISO 8601 UTC; null if not set. |
| `data.returnDate` | string<date-time> | Return date to the supplier in ISO 8601 UTC; null if not set. |
| `data.orderId` | string | Order that motivates the subrent; null if it has none. |
| `data.projectId` | string | Associated project; null if it has none. |
| `data.purchaseOrderId` | string | Purchase order that formalizes it; null if none has been issued. |
| `data.spaceId` | string | Warehouse where the material is received; null if not applicable. |
| `data.notes` | string | Subrent notes; null if it has none. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "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"
  }
}
```

304: No body.

## Errors

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

## Deprecation

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

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/subrents/get-a-subrent  
Last updated: 2026-10-25