*REST API › Endpoint reference › Rentals › Subrents*

# List subrents

> Returns the material rented from other companies to cover a job: what was brought in, from whom and for which order.

It answers "of this order, what is mine and what did I have to bring in". It does not emit what is paid to the supplier.

`GET /api/v1/subrents` — scope `subrents:read`

Scope: `subrents:read` · 120/min · Strict tenancy · MCP: `filmo_subrents_list`

## Authorizations

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

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `createdOn` | string | No | The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdAfter` | string | No | The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdBefore` | string | No | The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdFrom` | string | No | The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `createdTo` | string | No | The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedOn` | string | No | The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedAfter` | string | No | The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedBefore` | string | No | The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedFrom` | string | No | The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `updatedTo` | string | No | The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `sort` | string | No | Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, startDate, endDate, pickupDate, returnDate, status, type, quantity. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with. |
| `status` | string | No | Filter by subrent status. `pending`, `active`, `completed`, `cancelled` |
| `statuses` | string[] | No | Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. `pending`, `active`, `completed`, `cancelled` |
| `type` | string | No | Filter by type: bulk (quantity of a bulk item) or serialized (a specific unit). `bulk`, `serialized` |
| `types` | string[] | No | Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. `bulk`, `serialized` |
| `orderId` | string | No | Filter by the order that motivates it. |
| `orderIds` | string[] | No | Filter by orderId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. |
| `projectId` | string | No | Filter by associated project. |
| `projectIds` | string[] | No | Filter by projectId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. |
| `itemId` | string | No | Filter by subrented item. |
| `itemIds` | string[] | No | Filter by itemId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. |
| `returnOn` | string | No | The return date to the supplier (returnDate) falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `returnAfter` | string | No | The return date to the supplier (returnDate) is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `returnBefore` | string | No | The return date to the supplier (returnDate) is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `returnFrom` | string | No | The return date to the supplier (returnDate) is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `returnTo` | string | No | The return date to the supplier (returnDate) is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset. |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List subrents*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Response

Response schema: `SubrentDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 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. |
| 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[] |  |
| `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. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## 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/list-subrents  
Last updated: 2026-10-25