*REST API › Endpoint reference › Catalog & inventory › Items*

# List items

> Returns the inventory item catalog, cursor-paginated.

Strict per-subscription tenancy.

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

Scope: `items:read` · 120/min · Strict tenancy · MCP: `filmo_items_list`

## Authorizations

Bearer API key with the scope below. `items: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, name, sku, salePrice, depositValue, serializedItemsCount, collectionName. 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. |
| `query` | string | No | Free-text search (currently ILIKE over name, SKU, synonyms and serialized item codes). Semantics are NOT contractual: they may evolve without notice. |
| `stockType` | string | No | Filter by stock calculation method: serialized (by serialized items) or bulk (in bulk). `serialized`, `bulk` |
| `stockTypes` | string[] | No | Filter by stockType, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. `serialized`, `bulk` |
| `collectionId` | string | No | Filter by identifier of the collection the item belongs to. |
| `collectionIds` | string[] | No | Filter by collectionId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. |
| `ids` | string | No | Batch lookup by comma-separated identifiers (between 1 and 100), intended for synchronization. |
| `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 items*

**cURL**

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

**Node.js**

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

**Python**

```python
import requests

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

## Response

Response schema: `ItemDto`

| 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 identifier of the item. |
| `data.name` | string | Item name. |
| `data.sku` | string | SKU reference of the item; null if not recorded. |
| `data.description` | string | Item description; null if not recorded. |
| `data.orderInfo` | string | Additional information for the order (preparation/delivery notes); null if not recorded. |
| `data.ean` | string | EAN/barcode; null if not recorded. |
| `data.itemType` | string | Item type: fixed (simple item) or variant (item with variants). `fixed`, `variant` |
| `data.stockCalculationMethod` | string | Stock calculation method: bulk (in bulk, by quantity) or serialized (by serialized items). `bulk`, `serialized` |
| `data.collectionId` | string | Identifier of the collection it belongs to; null if it is in none. |
| `data.collectionName` | string | Name of the collection it belongs to; null if it is in none. |
| `data.images` | string[] | URLs of the item images. |
| `data.salePrice` | string | Sale price as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.depositValue` | string | Deposit amount as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.minStock` | number | Minimum stock configured for alerts; null if not configured. |
| `data.serializedItemsCount` | number | Number of serialized items registered for the item. |
| `data.pricingSettings` | object | Rental pricing configuration; null if not configured. |
| `data.pricingSettings.type` | string | Pricing mode: periodPrice (price per period), fixedPrice (fixed price) or pricingStructure (pricing structure); null if the item has none configured. `periodPrice`, `fixedPrice`, `pricingStructure` |
| `data.pricingSettings.price` | string | Base rental price as a decimal string "1234.50" (ROUND_HALF_UP); null if not applicable. |
| `data.pricingSettings.period` | string | Period unit of the price: hour, day, week or month; null if the item has none configured. `hour`, `day`, `week`, `month` |
| `data.insuranceEnabled` | boolean | Whether the item allows insurance. |
| `data.discountEnabled` | boolean | Whether the item allows discounts. |
| `data.bufferBefore` | number | Buffer time reserved before the rental; null if not applicable. |
| `data.bufferBeforeUnit` | string | Unit of the buffer before: hour or day; null if not applicable. `hour`, `day` |
| `data.bufferAfter` | number | Buffer time reserved after the rental; null if not applicable. |
| `data.bufferAfterUnit` | string | Unit of the buffer after: hour or day; null if not applicable. `hour`, `day` |
| `data.physicalProperties` | object | Physical properties (weight and dimensions); null if not recorded. |
| `data.physicalProperties.weight` | number | Item weight in kilograms; null if not recorded. |
| `data.physicalProperties.width` | number | Item width in centimeters; null if not recorded. |
| `data.physicalProperties.height` | number | Item height in centimeters; null if not recorded. |
| `data.physicalProperties.length` | number | Item length in centimeters; null if not recorded. |
| `data.physicalProperties.volume` | number | Item volume in cubic meters (m³); null if not recorded. |
| `data.physicalProperties.current` | number | Current draw in amperes; null if not recorded. |
| `data.physicalProperties.power` | number | Power in watts; null if not recorded. |
| `data.variants` | object[] | Item variants (empty if the item is of type fixed). |
| `data.variants.variantId` | string | Unique identifier of the variant. |
| `data.variants.variantName` | string | Variant name. |
| `data.variants.variantPrice` | string | Rental price of the variant as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.variants.salePrice` | string | Sale price of the variant as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.variants.ean` | string | EAN/barcode of the variant; null if not recorded. |
| `data.tags` | object[] | Tags associated with the item. |
| `data.tags.id` | string | Unique identifier of the tag. |
| `data.tags.name` | string | Tag name. |
| `data.customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `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": "item_9f3a2b",
      "name": "Example item",
      "sku": "CAM-FX6-01",
      "description": "Example text.",
      "orderInfo": "Example order info",
      "ean": "0000000000000",
      "itemType": "fixed",
      "stockCalculationMethod": "bulk",
      "collectionId": "collection_9f3a2b",
      "collectionName": "Example collection name",
      "images": [
        "Example images"
      ],
      "salePrice": "120.00",
      "depositValue": "120.00",
      "minStock": 1,
      "serializedItemsCount": 1,
      "pricingSettings": {
        "type": "periodPrice",
        "price": "120.00",
        "period": "hour"
      },
      "insuranceEnabled": true,
      "discountEnabled": true,
      "bufferBefore": 1,
      "bufferBeforeUnit": "hour",
      "bufferAfter": 1,
      "bufferAfterUnit": "hour",
      "physicalProperties": {
        "weight": 1,
        "width": 1,
        "height": 1,
        "length": 1,
        "volume": 1,
        "current": 1,
        "power": 1
      },
      "variants": [
        {
          "variantId": "variant_9f3a2b",
          "variantName": "Example variant name",
          "variantPrice": "120.00",
          "salePrice": "120.00",
          "ean": "0000000000000"
        }
      ],
      "tags": [
        {
          "id": "tag_9f3a2b",
          "name": "Example tag"
        }
      ],
      "customFields": {
        "example": "example"
      },
      "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/items/list-items  
Last updated: 2026-10-25