*MCP › Reference › Rentals › Orders* # List orders > Returns the rental orders, cursor-paginated. The `status` filter uses high-level operational buckets. The list is strict to the subscription of the key. TOOL `filmo_orders_list` · `orders:read` · 120/min · Server annotation: Read-only · Server annotation: Idempotent ## Arguments | 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. | | `q` | string | No | Free-text search on the order number, the project name or alias and the external reference. | | `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, orderNumber, grossPrice, rentalDays, itemsCount. 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 operational status bucket (UI view): draft, reserved, prepared (includes partial preparation), in_use (picked up/in use), returned (includes partial return/check-in), completed (checked in and completed) or cancelled. `draft`, `reserved`, `prepared`, `in_use`, `returned`, `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. `draft`, `reserved`, `prepared`, `in_use`, `returned`, `completed`, `cancelled` | | `contactId` | string | No | Filter by order contact identifier. | | `contactIds` | string[] | No | Filter by contactId, 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 identifier of the project the order belongs to. | | `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. | | `overlapsFrom` | string | No | Start of the overlap window (ISO 8601 with offset): returns orders whose rental period overlaps [overlapsFrom, overlapsTo]. | | `overlapsTo` | string | No | End of the overlap window (ISO 8601 with offset): returns orders whose rental period overlaps [overlapsFrom, overlapsTo]. | | `orderNumber` | string | No | Filter by order number: exact match or prefix match. | | `orderNumberIs` | string | No | Order number that matches exactly. | | `orderNumberContains` | string | No | Order number that contains this text at any position. | | `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` | | `dateFilters` | object | No | Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, ends, starts, updated. | | `dateFilters.created` | object | No | | | `dateFilters.created.gte` | string | No | From this day or instant, inclusive. | | `dateFilters.created.lte` | string | No | Up to this day or instant, inclusive. | | `dateFilters.created.gt` | string | No | Strictly after; a bare day means after the end of that day. | | `dateFilters.created.lt` | string | No | Strictly before; a bare day means before the start of that day. | | `dateFilters.created.on` | string | No | Exactly that day; an instant means the whole business day that contains it. | | `dateFilters.ends` | object | No | | | `dateFilters.ends.gte` | string | No | From this day or instant, inclusive. | | `dateFilters.ends.lte` | string | No | Up to this day or instant, inclusive. | | `dateFilters.ends.gt` | string | No | Strictly after; a bare day means after the end of that day. | | `dateFilters.ends.lt` | string | No | Strictly before; a bare day means before the start of that day. | | `dateFilters.ends.on` | string | No | Exactly that day; an instant means the whole business day that contains it. | | `dateFilters.starts` | object | No | | | `dateFilters.starts.gte` | string | No | From this day or instant, inclusive. | | `dateFilters.starts.lte` | string | No | Up to this day or instant, inclusive. | | `dateFilters.starts.gt` | string | No | Strictly after; a bare day means after the end of that day. | | `dateFilters.starts.lt` | string | No | Strictly before; a bare day means before the start of that day. | | `dateFilters.starts.on` | string | No | Exactly that day; an instant means the whole business day that contains it. | | `dateFilters.updated` | object | No | | | `dateFilters.updated.gte` | string | No | From this day or instant, inclusive. | | `dateFilters.updated.lte` | string | No | Up to this day or instant, inclusive. | | `dateFilters.updated.gt` | string | No | Strictly after; a bare day means after the end of that day. | | `dateFilters.updated.lt` | string | No | Strictly before; a bare day means before the start of that day. | | `dateFilters.updated.on` | string | No | Exactly that day; an instant means the whole business day that contains it. | ## Result On success the result carries `structuredContent` with `data` and `meta`. These are the attributes of `data`. | Name | Type | Description | | --- | --- | --- | | `id` | string | Unique order identifier. | | `orderNumber` | string | Human-readable order number. | | `externalReference` | string | External reference of the order (for example, from the customer system); null if not recorded. | | `status` | string | Raw order status as stored in the database (12 values): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived or cancelled. `archived` is part of the stored set but an archived order is not visible to the API, so you will not observe it. `draft`, `reserved`, `prepared_partially`, `prepared`, `picked_up_partially`, `picked_up`, `returned_partially`, `returned`, `checked_in_partially`, `checked_in`, `archived`, `cancelled` | | `startDate` | string | Start of the rental period in ISO 8601 with offset. | | `endDate` | string | End of the rental period in ISO 8601 with offset. | | `rentalDays` | number | Number of billable rental days; null if not calculated. | | `projectId` | string | Identifier of the project the order belongs to; null if not linked. | | `projectName` | string | Name of the project the order belongs to; null if not linked. | | `contact` | object | Compact reference to the order contact; null if none. | | `contact.id` | string | Unique contact identifier. | | `contact.name` | string | Contact name. | | `itemsCount` | integer | Number of items in the order. | | `subTotalPrice` | string | Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP). | | `discountTotal` | string | Total discounts as a decimal string "1234.50" (ROUND_HALF_UP); null if there is no discount. | | `insuranceTotal` | string | Insurance total as a decimal string "1234.50" (ROUND_HALF_UP). | | `depositTotal` | string | Deposit total as a decimal string "1234.50" (ROUND_HALF_UP). | | `taxesPrice` | string | Tax total as a decimal string "1234.50" (ROUND_HALF_UP). | | `netPrice` | string | Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP). | | `grossPrice` | string | Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP). | | `tags` | object[] | Tags attached to the order, with their identifier and name. | | `tags.id` | string | Unique identifier of the tag. | | `tags.name` | string | Tag name. | | `customFields` | object | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. | | `source` | string | Source the order was created from (for example web, mobile, admin); null if not recorded. | | `createdAt` | string | Creation date in ISO 8601 with offset. | | `updatedAt` | string | Last update date in ISO 8601 with offset. | *Call · filmo_orders_list* ```json { "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "filmo_orders_list", "arguments": { "limit": 20 } } } ``` *Result (generated from the schema)* ```json { "structuredContent": { "data": [ { "id": "id_8f2a1c", "orderNumber": "", "externalReference": "", "status": "draft", "startDate": "2026-09-01T08:00:00Z", "endDate": "2026-09-01T08:00:00Z", "rentalDays": 1, "projectId": "proj_8f2a1c", "projectName": "Example", "contact": { "id": "id_8f2a1c", "name": "Example" }, "itemsCount": 1, "subTotalPrice": "1234.50", "discountTotal": "1234.50", "insuranceTotal": "1234.50", "depositTotal": "1234.50", "taxesPrice": "1234.50", "netPrice": "1234.50", "grossPrice": "1234.50", "tags": [ { "id": "id_8f2a1c", "name": "Example" } ], "customFields": { "key": "" }, "source": "", "createdAt": "2026-09-01T08:00:00Z", "updatedAt": "2026-09-01T08:00:00Z" } ], "pagination": { "nextCursor": "eyJvIjo1MH0", "hasMore": true, "total": 1 }, "meta": { "rateLimit": { "limit": 120, "remaining": 119, "reset": 42 } } } } ``` ## Sample prompts *Prompt* ```text List the orders that start tomorrow, soonest first. ``` *Prompt* ```text Which orders are reserved but not yet prepared this week? ``` ## The same operation by REST This tool runs [`GET /api/v1/orders`](https://docs.filmo.io/rest-api/endpoint-reference/orders/list-orders). --- Canonical URL: https://docs.filmo.io/mcp/tools/orders/filmo-orders-list Last updated: 2026-10-25