public

GET /v1/public/kb

Browse or search the knowledge base.

Alle public Endpunkte

Authentifizierung

Dieser Endpunkt ist öffentlich. Er erfordert weder Anmeldedaten noch eine Organisation – er wird auch von unserer eigenen Marketing-Website und den KI-Antwort-Engines gelesen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/public/kb

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

**Anonymous** — no credential, no tenant. This is what the marketing site server-renders and what an AI answer engine crawls (§2.18), so it must work with no authentication at all. Published articles only, and that filter lives in every queryset rather than in a serializer so a new field or endpoint cannot leak a draft. `locale` names what the reader wants; the payload's `locale` reports what they actually got, field by field, with English as the floor.

Parameter

NameTypErforderlichWas es ist
cursor (query)stringNeinOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeinMaximum items to return (page size).
locale (query)stringNeinThe language to render in. An unknown value falls back to English rather than returning nothing, so a visitor whose browser sends a locale we do not serve reads the English arti…
category (query)stringNeinOnly articles in this category slug.
q (query)stringNeinFree text, minimum two characters.

Antwort

NameTypErforderlichWas es ist
dataKbArticle[]Ja
pagePageMetaJa

Fehler, die dieser Endpunkt zurückgeben kann

422 · 429