Miira · leads & WhatsApp v1 read-only
miira.
Searches the published catalog by words and returns up to 5 active public offerings with name, summary, price, currency and what the price is per; with exactly one match, also its whole description and attributes. Internal, paused and discontinued offerings never come back.
Last updated
POST /api/v1/reads/miira.catalog_search- Token scope
miira.catalog_search@1- Workspace permission
api.miira.catalog_searchoff by default- Who reads
- The person behind the token, with their role. Someone who leaves the workspace stops reading.
Three permissions
A token with that scope, the workspace owner having switched the read on, and the person's role seeing it in the product. None of them is enough alone. OAuth only →
Request
| field | type | rules | |
|---|---|---|---|
query | string | optional | max 200 |
Response — output when status is done
| field | type | rules | |
|---|---|---|---|
found | boolean | required | |
offerings | object[] | required | |
detail | object | null | required |
offerings[]
| field | type | rules | |
|---|---|---|---|
name | string | required | |
summary | string | required | |
price | string | null | required | |
currency | string | null | required | |
unit | "month" | "project" | "hour" | "unit" | "page" | null | required |
detail
| field | type | rules | |
|---|---|---|---|
description | string | null | required | |
attributes | map<string, string> | required |
Example
# Reads take an OAuth access token, not an API key, and no idempotency key: reading changes nothing.
curl -X POST https://niiko.org/api/v1/reads/miira.catalog_search \
-H "Authorization: Bearer $NIIKO_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
# 200 → done · 4xx → refused, with a named reasonWhy it may refuse
Each reason names who can fix it and how; detail.message, when present, says what to do. Refusals & HTTP codes →
invalid_inputrole_forbiddengrant_offreads_need_a_person
In the clients
| @vorluno/niiko-sdk | niiko.searchCatalog() |
| niiko (Python) | niiko.search_catalog() from 0.4.0 · not on the registry yet |
| niiko-cli | niiko read miira.catalog_search |
| n8n-nodes-niiko | No reads: the node holds a key, and reading needs a person through OAuth. |
| niiko-mcp-server | miira_catalog_search readOnlyHint |