Orders

List orders

Returns the rental orders, cursor-paginated.

Tool

filmo_orders_list

Readorders:read

orders:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_orders_list",
    "arguments": {
      "limit": 20
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "orderNumber": "<orderNumber>",
        "externalReference": "<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": "<key>"
        },
        "source": "<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
      }
    }
  }
}

generated from the schema

The status filter uses high-level operational buckets. The list is strict to the subscription of the key.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

qstring

Free-text search on the order number, the project name or alias and the external reference.

Limits: min length 1, max length 200

sortstring

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.

Limits: max length 200

statusstring

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.

Available options: draft, reserved, prepared, in_use, returned, completed, cancelled

statusesstring[]

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.

Available options: draft, reserved, prepared, in_use, returned, completed, cancelled

Limits: min 1 items, max 50 items

contactIdstring

Filter by order contact identifier.

Limits: min length 1, max length 100

contactIdsstring[]

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.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

projectIdstring

Filter by identifier of the project the order belongs to.

Limits: min length 1, max length 100

projectIdsstring[]

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.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

overlapsFromstring<date-time>

Start of the overlap window (ISO 8601 with offset): returns orders whose rental period overlaps [overlapsFrom, overlapsTo].

overlapsTostring<date-time>

End of the overlap window (ISO 8601 with offset): returns orders whose rental period overlaps [overlapsFrom, overlapsTo].

orderNumberstring

Filter by order number: exact match or prefix match.

Limits: min length 1, max length 100

orderNumberIsstring

Order number that matches exactly.

Limits: min length 1, max length 100

orderNumberContainsstring

Order number that contains this text at any position.

Limits: min length 1, max length 100

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

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.

Show child attributes

dateFilters.createdobject

Show child attributes

dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.endsobject

Show child attributes

dateFilters.ends.gtestring

From this day or instant, inclusive.

dateFilters.ends.ltestring

Up to this day or instant, inclusive.

dateFilters.ends.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.ends.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.ends.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.startsobject

Show child attributes

dateFilters.starts.gtestring

From this day or instant, inclusive.

dateFilters.starts.ltestring

Up to this day or instant, inclusive.

dateFilters.starts.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.starts.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.starts.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes

dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

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.

Show the attributes of data

idstring

Unique order identifier.

orderNumberstring

Human-readable order number.

externalReferencestring | null

External reference of the order (for example, from the customer system); null if not recorded.

statusstring

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.

Available options: draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled

startDatestring<date-time>

Start of the rental period in ISO 8601 with offset.

endDatestring<date-time>

End of the rental period in ISO 8601 with offset.

rentalDaysnumber | null

Number of billable rental days; null if not calculated.

projectIdstring | null

Identifier of the project the order belongs to; null if not linked.

projectNamestring | null

Name of the project the order belongs to; null if not linked.

contactobject | null

Compact reference to the order contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

itemsCountinteger

Number of items in the order.

subTotalPricestring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).