knowledge.list

List the shop-memory articles the shop's AI is grounded on

Read-onlyRead budget

REST

Shipping

POST /api/v1/knowledge/list

MCP tool

Live

knowledge.list

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Knowledge domain.

Operating contract

The facts this shop has written down about itself — its policies, its prices, its warranty terms, how it wants to sound. Every AI-drafted message this product sends is built on top of them.

THIS IS THE HIGHEST-LEVERAGE TEXT IN THE PRODUCT. One wrong fact here is repeated to every customer, in the shop's name, until somebody notices — and it never reads as a mistake, because it reads exactly like the true facts beside it. When you are checking why an agent said something odd, this is where to look first.

pinned: true marks a fact the shop cannot afford to lose out of a prompt. The recall budget is finite, and pinned facts are spent before unpinned ones — so pinning is how a shop's warranty terms survive a week of FAQ edits that would otherwise push them out.

last_verified_at is when somebody last confirmed the fact is still true. An unverified price from two years ago is the classic failure here: it is being quoted to customers today.

agent_keys: null means the fact applies to EVERY agent, which is what every fact written before per-agent scoping existed reads as. A non-null list is a fact deliberately narrowed to those agents and invisible to the rest.

active: false is a retired fact. It is kept for history and is not in any prompt.

READ ONLY. A machine that wrote its own grounding would be deciding what it believes about the shop tomorrow.

TRUNCATION: total is the exact number of facts and omitted is how many are not here. When omitted is not 0, narrow by category — a claim about what the shop's AI does or does not know, made from a partial read, is exactly wrong in the cases that matter.

Who may call it

Permission: shop.manageThe caller must hold shop.manage at the ACT level. A read-only dashboard grant on the same section is refused.
Plan: Every planNo plan gate. Available on every Service VIN plan.
Retries: naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class: readCounted against the read budget — the widest of the four.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.

Do not summarise from a truncated response

When `omitted` is not 0 the shop has more facts in memory than came back. Narrow by `category` or raise `limit` before saying what its AI does or does not know.

Input

Field	Type	Description
category	string	One memory category — services, pricing, policies, voice, faq or other. One of: `services`, `pricing`, `policies`, `voice`, `faq`, `other`
include_retired	boolean	True also returns facts the shop has retired. Defaults to false.
limit	integer1–200	How many facts to return, 1-200. Defaults to 50. Default: `50`

Output

Field	Type	Description
items	object[]	—
items[].id	string	—
items[].title	string	—
items[].body	string	—
items[].category	string	—
items[].category_label	string	—
items[].active	boolean	—
items[].pinned	boolean	—
items[].last_verified_at	string \| null	—
items[].agent_keys	string[] \| null	—
items[].source	string	—
items[].updated_at	string	—
total	number	—
omitted	number	—

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl

export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/knowledge/list \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":50}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/knowledge/list", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 50
  }),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)

import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/knowledge/list",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 50
},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "knowledge.list",
    "arguments": {
      "limit": 50
    }
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

Status	Code	When
404	`not_found`	The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403	`forbidden`	This login does not hold shop.manage.
422	`validation_error`	An argument was wrong. The message names the field.
429	`rate_limited`	Too many read calls. Back off and retry.
500	`internal_error`	Something failed on our side. Nothing was changed.

Operating contract#

Who may call it#

Partial answers#

Input#

Output#

Examples#

Refusals#