Catalog & inventory

Collection

Node of the tree the catalog is organized by.

Schemas: CollectionDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "path": "string",
  "entityType": "item",
  "parentId": "string",
  "depth": 1,
  "order": 1,
  "itemCount": 1,
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A node of the tree the catalog is organized by. Items, spaces, vehicles, staff and services hang from a collection. The list returns the tree as a flat list: every node carries its parentId, its full path and its depth, so you rebuild the tree in one pass with GET /api/v1/collections.

Attributes

idstring

Unique identifier of the collection.

namestring

Collection name.

pathstring

Full name from the top-level collection, with the levels joined by " > ".

entityTypestring

What the collection groups: item, space, vehicle, staff or service.

Available options: item, space, vehicle, staff, service

parentIdstring | null

Identifier of the parent collection; null for a top-level collection.

depthinteger

Levels above it: 0 for a top-level collection, 1 for its children, and so on.

ordernumber

Display order among its siblings.

itemCountinteger

Entities directly in this collection, without counting its sub-collections.

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.

Values

entityType: item, space, vehicle, staff, service

Returned by

GET /api/v1/collections — List collections

Modified by

No operation.

Was this page helpful?