Artikel auflisten

Gibt die Artikel Ihrer Help-Center-Wissensdatenbank zurück, neueste zuerst. In den Papierkorb verschobene Artikel werden nie zurückgegeben.

GET /v1/articles

Bearer-Token Scope content:read

curl 'https://api.ferndesk.com/v1/articles?start_cursor=eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ&page_size=20&format=markdown&status=published&collection_id=col_01JXYA6ABN52&updated_since=2026-01-15T18%3A25%3A43.511Z' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "art_01JXY9AZK4KV",
      "title": "Getting started with API keys",
      "slug": "getting-started-api-keys",
      "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
      "contentMarkdown": "# Welcome to the Ferndesk API",
      "contentJson": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Welcome to Ferndesk."
              }
            ]
          }
        ]
      },
      "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
      "sectionId": "sect_01JXYA4T1JNT",
      "collectionId": "col_01JXYA6ABN52",
      "status": "published",
      "layout": "default",
      "publishedAt": "2026-01-15T18:25:43.511Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Cursor-paginierte Artikel

Query-Parameter

· 6

start_cursor string

Opaker Cursor aus der vorherigen Antwort next_cursor.

page_size integer · min: 1· max: 100· Standard: 20

Elemente pro Seite.

format string · Standard: html· Enum

Welches Textfeld befüllt werden soll: contentHtml, contentMarkdown oder das verlustfreie contentJson.

Werte

html
markdown
json

status string · Standard: published· Enum

Einzuschließender Veröffentlichungsstatus; draft und all erfordern content:write und geben niemals in den Papierkorb verschobene Artikel zurück.

Werte

draft
published
all

collection_id string

Beschränkt die Liste auf eine Sammlung.

updated_since string · date-time · Muster

Gibt ab diesem Zeitpunkt geänderte Artikel zurück, zuerst die am längsten zurückliegenden Änderungen; wird ignoriert, sobald ein start_cursor die Sortierung vorgibt.

Query-Parameter

Antworten