Contracts

List contracts

Returns the rental contracts with their double status: status is the document status (draft, issued, voided) and operativeStatus the signature status.

Tool

filmo_contracts_list

Readcontracts:read

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

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

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "contractNumber": "<contractNumber>",
        "status": "draft",
        "operativeStatus": "pending",
        "signed": true,
        "signedAt": "2026-09-01T08:00:00Z",
        "contactId": "cont_8f2a1c",
        "orderId": "orde_8f2a1c",
        "orderNumber": "<orderNumber>",
        "projectId": "proj_8f2a1c",
        "contractDate": "2026-09-01T08:00:00Z",
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "grossPrice": "1234.50",
        "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

signed is what decides whether the material can go out. It does not include the legal clauses.

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

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, contractNumber, contractDate, startDate, endDate, status, signedAt, grossPrice. 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 document status: draft, validated (issued) or voided.

Available options: draft, validated, voided

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, validated, voided

Limits: min 1 items, max 50 items

operativeStatusstring

Filter by signature status: pending, signed or cancelled.

Available options: pending, signed, cancelled

operativeStatusesstring[]

Filter by operativeStatus, 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: pending, signed, cancelled

Limits: min 1 items, max 50 items

orderIdstring

Filter by associated order.

Limits: min length 1, max length 100

orderIdsstring[]

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.

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

projectIdstring

Filter by associated project.

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

contactIdstring

Filter by customer.

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

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, 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.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 contract identifier.

contractNumberstring | null

Contract number, for example "C260001"; null while it is a draft.

statusstring

Document status.

Available options: draft, validated, voided

operativeStatusstring

Signature status.

Available options: pending, signed, cancelled

signedboolean

true if the contract is recorded as signed. This is what decides whether the equipment can go out.

signedAtstring<date-time> | null

Signature date in ISO 8601 UTC; null if not signed.

contactIdstring | null

Customer identifier; null in drafts without a customer.

orderIdstring | null

Associated order; null if it has none.

orderNumberstring | null

Number of the associated order; null if it has none.

projectIdstring | null

Associated project; null if it has none.

contractDatestring<date-time> | null

Contract date in ISO 8601 UTC; null if not set.

startDatestring<date-time> | null

Start of validity in ISO 8601 UTC; null if not applicable.

endDatestring<date-time> | null

End of validity in ISO 8601 UTC; null if not applicable.

grossPricestring | null

Total amount including taxes as a decimal string "1234.50"; null if not applicable.

Limits: pattern ^-?\d+\.\d{2}$

createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/contracts.

Contracts
List contracts
Returns the rental contracts with their double status: status is the document status (draft, issued, voided) and operativeStatus the signature status.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List contracts

Safe writes

Errors