Catalogue API

List catalogue items

List products and services in the current workspace catalogue.

GET/v1/catalogue/items

capability catalogue.items.list · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

searchstring
querymin length 1max length 160
kind"product" | "service"
query
status"draft" | "active" | "archived"
query
limitinteger
querydefault 100min 1max 200

Response

Successful responses use Dawn's data envelope.

dataCatalogueItemListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- kind"product" | "service"required
- handlestringrequired
  min length 1max length 120
- namestringrequired
  min length 1max length 160
- descriptionstring | nullrequired
  max length 5000
- referencestring | nullrequired
  min length 1max length 120
- serviceDurationMinutesinteger | nullrequired
  min 5max 1440
- status"draft" | "active" | "archived"required
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

422The catalogue query is invalid.
503The catalogue is temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["catalogue.items.list"]({
  "search": "string",
  "kind": "product",
  "status": "draft",
  "limit": 100,
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "workspaceId": "22222222-2222-4222-8222-222222222222",
      "kind": "product",
      "handle": "string",
      "name": "string",
      "description": null,
      "reference": null,
      "serviceDurationMinutes": 5,
      "status": "draft",
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}