*REST API › Objects › Catalog & inventory*

# Kit

> Named group of items that go out together.

A named group of items that go out together, with its components and the collection it belongs to. Kits are bounded to the subscription that owns the key.

Schemas: `KitDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique identifier of the kit. |
| `name` | string | Kit name. |
| `description` | string | Kit description; null if it has none. |
| `image` | string | URL of the main image; null if it has none. |
| `collectionId` | string | Collection it belongs to; null if it is in none. |
| `collectionName` | string | Full path of the collection; null if it is in none. |
| `tags` | object[] | Kit tags, with their identifier and name. |
| `tags.id` | string | Unique identifier of the tag. |
| `tags.name` | string | Tag name. |
| `components` | object[] | Items that make up the kit, in display order. |
| `components.itemId` | string | Identifier of the item; read it in `/api/v1/items/{itemId}`. |
| `components.itemName` | string | Item name, as recorded when it was added to the kit. |
| `components.variantId` | string | Variant of the item, if one was chosen; null otherwise. |
| `components.variantName` | string | Name of that variant; null if none. |
| `components.quantity` | number | How many units of the item the kit includes. |
| `components.position` | number | Display order inside the kit (0-based); null if not set. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |

## Example

*Kit · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "name": "Example",
  "description": "string",
  "image": "string",
  "collectionId": "string",
  "collectionName": "Example",
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "components": [
    {
      "itemId": "string",
      "itemName": "Example",
      "variantId": "string",
      "variantName": "Example",
      "quantity": 1,
      "position": 1
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/kits`](https://docs.filmo.io/rest-api/endpoint-reference/kits/list-kits) — List kits
- [`GET /api/v1/kits/{kitId}`](https://docs.filmo.io/rest-api/endpoint-reference/kits/get-a-kit) — Get a kit

## Modified by

- [`POST /api/v1/kits`](https://docs.filmo.io/rest-api/endpoint-reference/kits/create-a-kit) — Create a kit
- [`PATCH /api/v1/kits/{kitId}`](https://docs.filmo.io/rest-api/endpoint-reference/kits/update-a-kit) — Update a kit

---

Canonical URL: https://docs.filmo.io/rest-api/objects/kit  
Last updated: 2026-10-25