Response Shapes

Read endpoints answer in a compact shape: short field names, and namespaces stored once per page instead of once per key.

The same endpoints back the MCP servers, where the abbreviation cuts token use by roughly half. The Admin SDK returns them unchanged rather than maintaining a second wire format, so keys.list() gives you k, not keys.

keys.list() #

const res = await admin.keys.list({ limit: 50 });

for (const key of res.k) {
  console.log(res.nss[key.ns], key.k); // "common", "auth.login.title"
}

Each entry in k:

fields defaults to ["id", "sourceText"]. Ask for translations only when you need the text, since it dominates the response size.

translations.get() #

Pass compact: true to get counts instead of text: each key becomes { id, k, ns?, tc } where tc is the translation count.

translations.pendingChanges() #

sync.list() and sync.get() #

list() returns { prj, tot, sy: [...] }. Each job:

get() adds log and aff_k, the affected keys as { k, act } pairs.

Write endpoints #

Writes answer with a receipt rather than the object you sent:

cnt is what the call touched, errors is per item, so a partial success is visible instead of being reported as a failure.

Always read hint and warn #

Several endpoints return a hint when a filter was silently ignored, or a warn when a write collided with something in another namespace. They are the only signal that a call did less than you asked.

const res = await admin.keys.create({ k: [{ n: "cta.title", v: "Get started" }] });
if (res.warn) console.warn(res.warn);