Kits

List kits

Returns the kits of the catalogue, cursor-paginated: named groups of items that go out together, with their components, collection and tags.

Tool

filmo_kits_list

Readkits:read

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

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

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "name": "Example",
        "description": "<description>",
        "image": "<image>",
        "collectionId": "coll_8f2a1c",
        "collectionName": "Example",
        "tags": [
          {
            "id": "id_8f2a1c",
            "name": "Example"
          }
        ],
        "components": [
          {
            "itemId": "item_8f2a1c",
            "itemName": "Example",
            "variantId": "vari_8f2a1c",
            "variantName": "Example",
            "quantity": 1,
            "position": 1
          }
        ],
        "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

Filter by collection and by tag (any of the given tags). Sorted by name; sort accepts a single field. Creation and update date filters are not available on this listing.

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: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: name, createdAt, updatedAt. Defaults to "name". 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

collectionIdstring

Filter by identifier of the collection the kit belongs to.

Limits: min length 1, max length 100

collectionIdsstring[]

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.

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

tagIdstring

Filter by tag identifier: kits that carry that tag.

Limits: min length 1, max length 100

tagIdsstring[]

Filter by tagId, 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.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique identifier of the kit.

namestring

Kit name.

descriptionstring | null

Kit description; null if it has none.

imagestring | null

URL of the main image; null if it has none.

collectionIdstring | null

Collection it belongs to; null if it is in none.

collectionNamestring | null

Full path of the collection; null if it is in none.

tagsobject[]

Kit tags, with their identifier and name.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

componentsobject[]

Items that make up the kit, in display order.

Show child attributes

components.itemIdstring

Identifier of the item; read it in /api/v1/items/{itemId}.

components.itemNamestring

Item name, as recorded when it was added to the kit.

components.variantIdstring | null

Variant of the item, if one was chosen; null otherwise.

components.variantNamestring | null

Name of that variant; null if none.

components.quantitynumber

How many units of the item the kit includes.

components.positionnumber | null

Display order inside the kit (0-based); null if not set.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

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/kits.

Kits
List kits
Returns the kits of the catalogue, cursor-paginated: named groups of items that go out together, with their components, collection and tags.
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 kits

Safe writes

Errors