zendesk-guide-api-articles-list
eesel Team
Last edited February 26, 2026
{
"title": "So listen Sie Zendesk Guide-Artikel mithilfe der API auf: eine vollständige Anleitung",
"slug": "zendesk-guide-api-articles-list",
"locale": "de",
"date": "2026-02-25",
"updated": "2026-02-25",
"template": "default",
"excerpt": "Eine Schritt-für-Schritt-Anleitung zur Verwendung der Zendesk Guide-API zum programmgesteuerten Auflisten und Verwalten von Help Center-Artikeln.",
"categories": [
"Zendesk",
"Guides"
],
"tags": [
"Zendesk",
"API",
"Help Center",
"Developer",
"Integration"
],
"readTime": 10,
"author": 16,
"reviewer": 14,
"seo": {
"title": "So listen Sie Zendesk Guide-Artikel mithilfe der API auf: eine vollständige Anleitung",
"description": "Eine Schritt-für-Schritt-Anleitung zur Verwendung der Zendesk Guide-API zum programmgesteuerten Auflisten und Verwalten von Help Center-Artikeln.",
"image": "https://wmeojibgfvjvinftolho.supabase.co/storage/v1/object/public/public_assets/blog-gen/banner-aa4d8e3a-8d22-4e7d-9218-439f1e1b0a33"
},
"coverImage": "https://wmeojibgfvjvinftolho.supabase.co/storage/v1/object/public/public_assets/blog-gen/banner-aa4d8e3a-8d22-4e7d-9218-439f1e1b0a33",
"coverImageAlt": "Bannerbild für So listen Sie Zendesk Guide-Artikel mithilfe der API auf: eine vollständige Anleitung",
"coverImageWidth": 1920,
"coverImageHeight": 1080,
"faqs": {
"heading": "Häufig gestellte Fragen",
"type": "blog",
"answerType": "html",
"faqs": [
{
"question": "Wie erhalte ich eine vollständige Zendesk Guide-API-Artikelliste, wenn ich Tausende von Artikeln habe?",
"answer": "Verwenden Sie die Cursor-Paginierung mit ?page[size]=100 und folgen Sie den Links.next-URL in jeder Antwort, bis sie Null zurückgibt. Dadurch werden alle Artikel ohne die 100-Seiten-Beschränkung der Offset-Paginierung abgerufen."
},
{
"question": "Welche Authentifizierungsmethode sollte ich für die Zendesk Guide-API zum Auflisten von Artikeln verwenden?",
"answer": "Verwenden Sie die Standardauthentifizierung mit Ihrer E-Mail-Adresse und einem API-Token (API-Schlüssel). Das Format ist {email}/token:{api_token}, das in Base64 für den Autorisierungs-Header codiert ist."
},
{
"question": "Kann ich die Zendesk Guide-API-Artikelliste filtern, um Entwurfsartikel auszuschließen?",
"answer": "Ja. Jedes Artikelobjekt enthält ein boolesches Entwurfsfeld. Filtern Sie Ihre Ergebnisse im Code, indem Sie prüfen, ob nicht article['draft'], um nur veröffentlichte Artikel einzubeziehen."
},
{
"question": "Wie gehe ich mit Ratenbegrenzungen um, wenn ich eine große Anzahl von Artikeln über die Zendesk-API aufliste?",
"answer": "Überwachen Sie auf 429-Statuscodes und implementieren Sie exponentiellen Backoff. Fügen Sie Verzögerungen zwischen den Anfragen hinzu (z. B. 500 ms) und versuchen Sie es erneut, nachdem das Ratenbegrenzungsfenster zurückgesetzt wurde."
},
{
"question": "Gibt es eine Möglichkeit, nur Artikel abzurufen, die sich seit einem bestimmten Datum über die Zendesk Guide-API geändert haben?",
"answer": "Ja. Verwenden Sie den inkrementellen Endpunkt /api/v2/help_center/incremental/articles mit einem start_time-Parameter, der einen Unix-Epochen-Zeitstempel enthält."
}
],
"supportLink": null
}
}
---
Wenn Sie programmatisch auf Ihre Zendesk Help Center-Inhalte zugreifen möchten, sei es zum Erstellen eines benutzerdefinierten Suchindexes, zum Erstellen von Backups oder zum Synchronisieren von Artikeln mit einer anderen Plattform, ist die Zendesk Guide API Ihr ideales Werkzeug. Aber wie bei vielen REST-APIs kann sich der Einstieg überwältigend anfühlen. Es gibt die Authentifizierung, die es herauszufinden gilt, die Paginierung, die es zu handhaben gilt, und eine Vielzahl von Endpunkten, aus denen Sie wählen können.
Diese Anleitung führt Sie durch alles, was Sie wissen müssen, um Artikel aus Zendesk Guide mithilfe der API aufzulisten und abzurufen. Wir behandeln die Authentifizierung, das Stellen Ihrer ersten Anfragen, die Handhabung der Paginierung für große Inhaltsbibliotheken und reale Codebeispiele, die Sie an Ihre Bedürfnisse anpassen können.
## Was Sie für den Anfang benötigen
Bevor Sie in API-Aufrufe eintauchen, stellen Sie sicher, dass Sie diese Voraussetzungen erfüllen:
- **Ein Zendesk-Konto mit Administrator- oder Agentenzugriff** – Sie benötigen die entsprechenden Berechtigungen, um API-Token (API-Schlüssel) zu generieren und auf Help Center-Inhalte zuzugreifen
- **Ein API-Token (API-Schlüssel)** – generiert über Ihr Zendesk Admin Center (wir behandeln dies in Schritt 1)
- **Grundlegende Vertrautheit mit REST-APIs** – Verständnis der HTTP-Methoden (GET, POST), des JSON-Formats und der Anfrage-Header
- **Ein Tool zum Stellen von API-Anfragen** – dies könnte cURL, Postman oder eine Programmierumgebung wie Python oder Node.js sein
- **Kenntnis der Ratenbegrenzungen Ihres Plans** – Zendesk erzwingt unterschiedliche Anfragelimits basierend auf Ihrer Abonnementstufe
Apropos Ratenbegrenzungen, hier ist, womit Sie je nach Ihrem Plan arbeiten:
| Plan | Anfragen pro Minute |
|------|---------------------|
| Essential | 10 RPM |
| Team | 200 RPM |
| Professional | 400 RPM |
| Enterprise | 700 RPM |
| High Volume Add-on | 2.500 RPM |
Wenn Sie diese Limits überschreiten, erhalten Sie einen 429-Fehler. Die API folgt den Anfragelimits pro Minute der Support-API, und Anfragen in einer API werden nicht gegen das Ratenlimit der anderen gezählt.
## Die Struktur der Zendesk Guide API verstehen
Die [Zendesk Help Center API](https://developer.zendesk.com/api-reference/help_center/help-center-api/introduction/) ist eine REST-API, mit der Sie programmgesteuert mit Ihren Wissensdatenbankinhalten interagieren können. Bevor Sie Anfragen stellen, ist es hilfreich zu verstehen, wie Inhalte organisiert sind.
Zendesk Guide folgt einer hierarchischen Struktur:
- **Kategorien** sind die Container der obersten Ebene zum Organisieren von Inhalten
- **Abschnitte** befinden sich innerhalb von Kategorien und gruppieren verwandte Artikel
- **Artikel** sind die eigentlichen Inhaltsteile (Hilfethemen, FAQs, Anleitungen)
Wenn Sie Artikel über die API auflisten, können Sie alle Artikel in Ihrem Help Center abrufen oder nach bestimmten Kategorien oder Abschnitten filtern. Die API gibt JSON-Antworten zurück, die Artikel-Metadaten wie Titel, Inhaltstext, Autoreninformationen, Entwurfsstatus und mehr enthalten.
Die Authentifizierung erfolgt über Basic Auth mit Ihrer E-Mail-Adresse und einem API-Token (API-Schlüssel). Das Format ist `{email_address}/token:{api_token}`, das für den Autorisierungs-Header Base64-codiert wird.
Ein wichtiger Hinweis: Antworten werden immer gemäß den Berechtigungen des Benutzers gefiltert, der die Anfrage stellt. Wenn Sie sich also als Endbenutzer und nicht als Agent oder Administrator authentifizieren, sehen Sie nur Artikel, die dieser Benutzer anzeigen darf.
## Schritt 1: API-Authentifizierung einrichten
Um die API nutzen zu können, benötigen Sie ein API-Token (API-Schlüssel). So generieren Sie eines:
1. Melden Sie sich als Administrator bei Ihrem Zendesk-Konto an
2. Navigieren Sie zu **Admin Center** → **Kanäle** → **API**
3. Klicken Sie auf die Registerkarte **Einstellungen**
4. Aktivieren Sie **Token-Zugriff**, falls dies noch nicht der Fall ist
5. Klicken Sie auf die Schaltfläche **+**, um ein neues Token hinzuzufügen
6. Geben Sie Ihrem Token einen beschreibenden Namen (z. B. "Artikel-Export-Skript")
7. Kopieren Sie das Token sofort – Zendesk zeigt es nur einmal an
Sobald Sie Ihr Token haben, können Sie die Authentifizierung mit einer einfachen cURL-Anfrage testen:
```bash
curl https://{your_subdomain}.zendesk.com/api/v2/help_center/articles \
-v -u {your_email}/token:{your_api_token}
Ersetzen Sie {your_subdomain} durch Ihre Zendesk-Subdomain, {your_email} durch Ihre Konto-E-Mail und {your_api_token} durch das Token, das Sie gerade generiert haben.
Wenn die Authentifizierung erfolgreich ist, sehen Sie einen 200-Statuscode und eine JSON-Antwort mit Ihren Artikeln. Wenn Sie einen 401-Fehler erhalten, überprüfen Sie, ob Ihr Token aktiv ist und Ihre E-Mail-/Token-Kombination korrekt ist.
Häufige Authentifizierungsprobleme:
- 401 Nicht autorisiert – Token ist inaktiv oder E-Mail-/Token-Format ist falsch
- 403 Verboten – Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen
- 404 Nicht gefunden – Endpunkt-URL ist falsch
Schritt 2: Alle Artikel mit einfachem API-Aufruf auflisten
Nachdem Sie sich authentifiziert haben, rufen wir Artikel ab. Der primäre Endpunkt zum Auflisten von Artikeln ist:
GET /api/v2/help_center/articles
Hier ist ein vollständiges Python-Beispiel mit der requests-Bibliothek:
import requests
from requests.auth import HTTPBasicAuth
subdomain = 'your_subdomain'
email = 'your_email@example.com'
api_token = 'your_api_token'
url = f'https://{subdomain}.zendesk.com/api/v2/help_center/articles'
response = requests.get(
url,
auth=HTTPBasicAuth(f'{email}/token', api_token),
headers={'Content-Type': 'application/json'}
)
data = response.json()
articles = data['articles']
for article in articles:
if not article['draft']: # Skip drafts
print(f"{article['id']}: {article['title']}")
Die Antwort enthält ein articles-Array, in dem jedes Artikelobjekt Felder wie die folgenden enthält:
| Feld | Beschreibung |
|---|---|
id | Eindeutiger Artikelbezeichner |
title | Artikelüberschrift |
body | HTML-Inhalt des Artikels |
section_id | ID des Abschnitts, der diesen Artikel enthält |
draft | Boolescher Wert, der angibt, ob der Artikel ein Entwurf ist |
created_at | ISO 8601-Zeitstempel der Erstellung |
updated_at | ISO 8601-Zeitstempel der letzten Aktualisierung |
author_id | ID des Benutzers, der den Artikel erstellt hat |
Standardmäßig gibt dieser Endpunkt 30 Artikel pro Seite zurück. Wenn Sie mehr Artikel haben, müssen Sie die Paginierung handhaben (wird in Schritt 3 behandelt).
Schritt 3: Paginierung für große Artikellisten handhaben
Die Paginierung ist der Punkt, an dem viele Entwickler stecken bleiben. Die Zendesk Guide API unterstützt zwei Paginierungsmethoden: Cursor-Paginierung (empfohlen) und Offset-Paginierung.
Die Cursor-Paginierung ist der moderne Ansatz und funktioniert, indem den "next"-Links in der API-Antwort gefolgt wird. Sie ist effizienter für große Datensätze und hat nicht die Seitenbeschränkungen der Offset-Paginierung.
Um die Cursor-Paginierung zu verwenden, fügen Sie ?page[size]=100 zu Ihrer Anfrage hinzu (100 ist das Maximum). Hier ist eine vollständige Python-Implementierung, die ALLE Artikel über alle Seiten abruft:
import requests
from requests.auth import HTTPBasicAuth
def get_all_articles(subdomain, email, api_token):
articles = []
url = f'https://{subdomain}.zendesk.com/api/v2/help_center/articles?page[size]=100'
while url:
response = requests.get(
url,
auth=HTTPBasicAuth(f'{email}/token', api_token),
headers={'Content-Type': 'application/json'}
)
if response.status_code != 200:
print(f"Error: {response.status_code}")
break
data = response.json()
articles.extend(data['articles'])
# Get the next page URL from the links object
url = data.get('links', {}).get('next')
print(f"Retrieved {len(articles)} articles so far...")
return articles
all_articles = get_all_articles('your_subdomain', 'your_email', 'your_token')
print(f"Total articles: {len(all_articles)}")
Der Schlüssel ist die Überprüfung auf data['links']['next']. Wenn Sie die letzte Seite erreichen, ist dieser Wert null und Ihre Schleife endet.
Die Offset-Paginierung ist die ältere Methode und ist auf maximal 100 Seiten beschränkt. Sie verwendet die Parameter per_page und page. Zendesk empfiehlt die Cursor-Paginierung für neue Implementierungen.
Beachten Sie bei der Paginierung durch große Datensätze die Ratenbegrenzungen. Wenn Sie Tausende von Artikeln haben, sollten Sie eine kleine Verzögerung zwischen den Anfragen hinzufügen:
import time
time.sleep(0.5) # 500ms delay
Schritt 4: Artikel filtern und sortieren
Die API bietet verschiedene Möglichkeiten, Ihre Artikellisten zu filtern und zu sortieren.
Filtern nach Labels: Wenn Sie Artikel-Labels verwenden (verfügbar in Professional- und Enterprise-Plänen), können Sie nach diesen filtern:
GET /api/v2/help_center/articles?label_names=photos,camera
Dies gibt nur Artikel zurück, die ALLE angegebenen Labels haben. Beim Label-Abgleich wird die Groß-/Kleinschreibung beachtet.
Sortieren:
Verwenden Sie die Parameter sort_by und sort_order, um die Reihenfolge zu steuern:
| Sortieroption | Beschreibung |
|---|---|
position | Manuelle Reihenfolge von der Seite "Inhalte anordnen" (Standard) |
title | Alphabetisch nach Titel |
created_at | Erstellungszeit |
updated_at | Letzte Aktualisierungszeit |
edited_at | Letzte Bearbeitungszeit von Titel oder Text |
Beispiel: /api/v2/help_center/articles?sort_by=updated_at&sort_order=desc
Inkrementelle Exporte:
Verwenden Sie zum Synchronisieren von Artikeln mit externen Systemen den inkrementellen Endpunkt mit einem start_time-Parameter:
GET /api/v2/help_center/incremental/articles?start_time=1704067200
Die start_time ist ein Unix-Epochen-Zeitstempel. Dies gibt nur Artikel zurück, die seit diesem Zeitpunkt erstellt oder aktualisiert wurden.
Auflisten nach Kategorie oder Abschnitt: So rufen Sie Artikel aus einer bestimmten Kategorie ab:
GET /api/v2/help_center/categories/{category_id}/articles
Oder aus einem bestimmten Abschnitt:
GET /api/v2/help_center/sections/{section_id}/articles
Sideloading verwandter Daten: Um API-Aufrufe zu reduzieren, können Sie verwandte Ressourcen sideloaden:
GET /api/v2/help_center/articles?include=users,sections,categories
Dies schließt die vollständigen Benutzer-, Abschnitts- und Kategorieobjekte in die Antwort ein, sodass Sie keine separaten API-Aufrufe für diese Informationen tätigen müssen.
Häufige Anwendungsfälle und Codebeispiele
Hier sind einige praktische Implementierungen für häufige Szenarien:
Alle Artikel für die Suchindizierung exportieren: Dieses Skript exportiert alle veröffentlichten Artikel in eine JSON-Datei, filtert Entwürfe heraus und enthält nur die wichtigsten Felder:
import json
import requests
from requests.auth import HTTPBasicAuth
def export_articles_for_search(subdomain, email, api_token, output_file):
articles = []
url = f'https://{subdomain}.zendesk.com/api/v2/help_center/articles?page[size]=100'
while url:
response = requests.get(url, auth=HTTPBasicAuth(f'{email}/token', api_token))
data = response.json()
for article in data['articles']:
if not article['draft']:
articles.append({
'id': article['id'],
'title': article['title'],
'body': article['body'],
'url': article['html_url'],
'updated_at': article['updated_at']
})
url = data.get('links', {}).get('next')
with open(output_file, 'w') as f:
json.dump(articles, f, indent=2)
print(f"Exported {len(articles)} articles to {output_file}")
Best Practices für die Fehlerbehandlung: Behandeln Sie immer potenzielle Fehler in Ihren API-Aufrufen:
response = requests.get(url, auth=auth)
if response.status_code == 429:
# Rate limit hit wait and retry
time.sleep(60)
response = requests.get(url, auth=auth)
elif response.status_code == 401:
print("Authentication failed check your API token")
sys.exit(1)
elif response.status_code != 200:
print(f"API error: {response.status_code}")
print(response.text)
Zendesk Guide-Inhalte mit eesel AI verwalten
Während Ihnen die Zendesk Guide API programmgesteuerten Zugriff auf Ihre Help Center-Inhalte ermöglicht, kommt eesel AI ins Spiel, wenn es darum geht, diese Inhalte effektiv zu verwalten und zu nutzen.
Anstatt benutzerdefinierte Skripte zum Synchronisieren von Artikeln zu erstellen, verbindet sich unser KI-Agent direkt mit Ihrem Zendesk Guide und lernt automatisch aus Ihren Help Center-Inhalten. Das bedeutet:
- No-Code-Setup – Verbinden Sie Ihr Zendesk-Konto und eesel AI importiert Ihre Artikel automatisch
- Immer auf dem neuesten Stand – Wenn Sie Artikel in Zendesk aktualisieren, lernt eesel AI die Änderungen
- Mehrsprachige Unterstützung – Funktioniert mit Artikeln in allen 80+ Sprachen, die Zendesk unterstützt
- Intelligente Antworten – Unsere KI beantwortet Kundenfragen anhand Ihrer Help Center-Inhalte als Quelle der Wahrheit
Für Teams, die KI-gestützten Support ohne technischen Aufwand aufbauen möchten, übernimmt eesel AI die Komplexität der Synchronisierung, Indizierung und des Abrufens der richtigen Artikelinhalte zum richtigen Zeitpunkt. Sie können mit AI Copilot beginnen, um Antworten für Ihre Agenten zu entwerfen, und dann auf die vollständige AI Agent-Automatisierung umsteigen, wenn Sie mehr Vertrauen gewinnen.
Beginnen Sie noch heute mit dem Aufbau mit der Zendesk Guide API
Sie haben jetzt alles, was Sie brauchen, um mit der Zendesk Guide API zu arbeiten. Hier ist eine kurze Zusammenfassung:
- Generieren Sie ein API-Token (API-Schlüssel) über Ihr Zendesk Admin Center
- Stellen Sie authentifizierte Anfragen mithilfe von Basic Auth mit Ihrer E-Mail und Ihrem Token
- Handhaben Sie die Paginierung mithilfe der Cursor-Paginierung für große Artikelbibliotheken
- Filtern und sortieren Sie mithilfe von Abfrageparametern, um genau die Daten zu erhalten, die Sie benötigen
Weitere erweiterte Funktionen wie das Erstellen oder Aktualisieren von Artikeln, das Verwalten von Übersetzungen oder das Arbeiten mit Artikelanhängen finden Sie in der offiziellen Zendesk API-Dokumentation.
Und wenn Sie mehr mit Ihren Help Center-Inhalten tun möchten – wie z. B. KI-Antworten zu unterstützen, eine benutzerdefinierte Suche zu erstellen oder automatisierte Workflows zu erstellen – überlegen Sie, wie eesel AI Ihnen helfen kann, schneller dorthin zu gelangen, ohne benutzerdefinierten Integrationscode zu schreiben.
Diesen Beitrag teilen
Article by
