Lesen Sie Artikel, Sammlungen und Änderungsprotokolleinträge mit der Notiondesk API.

Die Notiondesk-API liest alle Veröffentlichungen Ihres Hilfezentrums: jeden Artikel und jede Sammlung in jeder Sprache, inklusive Inhalt im Markdown-Format, Veröffentlichungsstatus und Synchronisierungsstatus sowie Ihre veröffentlichten Änderungsprotokolleinträge. Nutzen Sie sie, um Ihr Hilfezentrum zu sichern, Ihre Inhalte an ein anderes Tool zu übergeben oder zu überprüfen, welche Artikel nicht synchronisiert wurden.

Die API liest Inhalte, schreibt sie aber nie. Ihre Artikel und Sammlungen bleiben in Notion: Um einen Artikel oder eine Sammlung zu ändern, bearbeiten Sie ihn in Notion und lösen Sie eine Synchronisierung aus .

In der Notiondesk API wird eine Sammlung als Kategorie bezeichnet.

Sprache auswählen

Jede Route auf dieser Seite akzeptiert einen optionalen Abfrageparameter locale, z. B. ?locale=fr. Ohne diesen Parameter wird die Standardsprache des Hilfecenters verwendet. Bei den Listenrouten muss locale eine der vom Hilfecenter unterstützten Sprachen sein: die supported_locales des Hilfecenters . Informationen zum Hinzufügen von Sprachen finden Sie unter „Mehrere Sprachen in Ihrem Hilfecenter unterstützen“ .

Artikelliste

Die Liste enthält alle Artikel in allen Status, Entwürfe und archivierte Artikel in der Reihenfolge ihrer Erstellung. Blättern Sie mit page_size und cursor durch die Liste, wie in den API-Anfragen „Paginate“ und „version Notiondesk“ beschrieben.

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles?page_size=100&locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "1761580412",
      "title": "Connect your Notion workspace",
      "slug": "connect-your-notion-workspace",
      "status": "published",
      "categories": [
        {"id": "910000002", "name": "Connecting Notion", "slug": "connecting-notion", "locale": "en", "status": "published"}
      ],
      "tags": [{"name": "Setup", "slug": "setup"}],
      "locales_count": 2,
      "updated_at": "2026-10-18T14:39:03+00:00",
      "published_at": "2026-10-05T04:39:04+00:00",
      "locale": "en",
      "reading_time": 3,
      "views_count": 42,
      "reactions_percent": {"smiley": 50, "neutral_face": 25, "disappointed": 25},
      "source_notion_page_id": "3d5001d0-2470-8122-a1b2-c3d4e5f60789",
      "notion_article_page_url": "https://www.notion.so/3d5001d024708122a1b2c3d4e5f60789",
      "sync_in_progress": false,
      "sync_timeout": false,
      "sync_failed": false,
      "sync_error_code": null,
      "auto_translated": false
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

Hinweis: Filtern Sie die Ergebnisse in Ihrem Code, um alle Artikel zu finden, deren letzte Synchronisierung fehlgeschlagen ist, beheben Sie das Problem dann in Notion und synchronisieren Sie ihn erneut .sync_failed: true

Einen Artikel als Markdown lesen

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles/1761580412?locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "id": "1761580412",
  "type": "article",
  "title": "Connect your Notion workspace",
  "slug": "connect-your-notion-workspace",
  "text": "# Connect your Notion workspace\n\nOpen **Settings**, then **Notion**...",
  "url": "https://help.example.com/en/articles/connect-your-notion-workspace",
  "locale": "en",
  "last_updated": "2026-10-18T14:39:03+00:00",
  "category": {"id": "910000002", "title": "Connecting Notion", "slug": "connecting-notion"},
  "tags": ["setup"],
  "truncated": false,
  "author": {"name": "Ada Lovelace"},
  "status": "published",
  "content_available": true,
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null
}

Jeder Status ist lesbar, sodass Sie einen Entwurf vor der Veröffentlichung lesen können. Ein Artikel ohne Übersetzung in der angeforderten Sprache (locale) führt zu einem 404-Fehler (not_found).

Sammlungen auflisten

Jeder Eintrag ist eine Sammlung in der angeforderten Sprache, in der Reihenfolge, in der die Sammlungen erstellt wurden:

Erstellen Sie Ihre Sammlungsstruktur mit drei Feldern neu:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/categories?page_size=100" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "id": "910000001",
  "name": "Getting Started",
  "slug": "getting-started",
  "updated_at": "2026-10-18T14:39:12+00:00",
  "locale": "en",
  "is_parent": true,
  "source_notion_page_id": "5d5001d0-2470-8122-a1b2-c3d4e5f60789",
  "notion_category_page_url": "https://www.notion.so/5d5001d024708122a1b2c3d4e5f60789",
  "sync_in_progress": false,
  "sync_timeout": false,
  "sync_failed": false,
  "sync_error_code": null,
  "parent_ids": [],
  "children_ids": ["910000002"],
  "locales_count": 2,
  "status": "published",
  "auto_translated": false
}

Die Liste enthält keine Artikelanzahl. Um die Artikel einer Sammlung zu zählen, listen Sie die Artikel auf und gruppieren Sie sie nach categories. Erfahren Sie unter „Sammlungen zur Organisation Ihrer Artikel verwenden“, wie Sammlungen Ihr Hilfezentrum strukturieren.

Eine Sammlung lesen

Die Antwort hat die gleiche Struktur wie ein Artikel: type besteht aus category, title, slug, url, status, den Synchronisierungsfeldern und text mit dem eigenen Inhalt der Sammlung als Markdown, der leer ist, wenn er keinen Inhalt hat.

Liste der Änderungsprotokolleinträge

Das Änderungsprotokoll listet die veröffentlichten Artikel Ihrer Änderungsprotokollsammlungen auf, beginnend mit dem neuesten. Sie können es unter „Änderungsprotokolle einrichten“ in Ihrem Hilfecenter konfigurieren .

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/categories/910000001?locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/changelog?page_size=50&locale=en" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "article:1761497350",
      "title": "Multilingual sync is now available",
      "slug": "multilingual-sync-is-now-available",
      "text": "Help centers on the Enterprise plan can now sync every configured locale in a single run instead of one language at a time.",
      "published_at": "2026-10-13T09:12:44+00:00",
      "last_updated": "2026-10-18T14:39:03+00:00",
      "tags": [],
      "url": "https://help.example.com/en/changelogs",
      "locale": "en"
    }
  ],
  "has_more": true,
  "next_cursor": "OPAQUE_CURSOR"
}

Gut zu wissen:

• Ein Eintrag wird nur dann angezeigt, wenn seine Änderungsprotokollsammlung in der angeforderten Sprache veröffentlicht wurde.

• In einem Hilfecenter, das Gastkonten verwendet, werden in der Liste nur die Einträge angezeigt, die jeder Leser sehen kann.

• Die Liste umfasst höchstens die 1000 neuesten Einträge. Darüber hinaus bleibt has_more auch dann false, wenn ältere Einträge vorhanden sind.

• In seltenen Fällen kann es bei vorübergehenden Serviceproblemen vorkommen, dass eine Liste einen Eintrag überspringt oder wiederholt. Lesen Sie die Liste später erneut, um die vollständige Liste zu erhalten.

Fehler

Jede Route kann auch invalid_version, authentication_error, rate_limited und internal_error beantworten. Siehe „Behandlung von Notiondesk-API-Fehlern, Ratenbegrenzungen und Wiederholungsversuchen“ .

Häufig gestellte Fragen

Was kommt als Nächstes?

• Trigger Notion synchronisiert sich mit der Notiondesk API

• Sprachen und automatische Übersetzung mit der Notiondesk API verwalten.

• Automatisieren Sie häufige Aufgaben im Hilfecenter mit der Notiondesk API