Ferndesk

Aufgaben

Aufgaben auflisten

Gibt die Aufgaben Ihrer Organisation zurück, neueste zuerst, cursor-paginiert. Filtern Sie mit status. Erfordert den content:write-Scope.

Erforderlicher Scope: content:write

GET /tasks

Aufgaben auflisten

curl --request GET \
  --url 'https://api.ferndesk.com/v1/tasks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "results": [
    {
      "id": "<string>",
      "title": "<string>",
      "status": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Cursor-paginierte Aufgaben

Authorizations

  • Authorization string erforderlich header

    Alle Anfragen erfordern ein Bearer-Token im Authorization-Header. API-Schlüssel beginnen mit fdsk_ und sollten geheim gehalten werden. Sie können Schlüssel auf der Seite Entwicklereinstellungen erstellen und verwalten.

    Schlüssel können auf eine beliebige Teilmenge dieser Scopes beschränkt werden (jeder Endpunkt führt den erforderlichen Scope über x-required-scopes auf):

    • content:read: Hilfecenter-Artikel, Sammlungen, Abschnitte und Übersetzungen lesen und durchsuchen
    • content:write: Artikelentwürfe, Benutzer und Aufgaben erstellen und bearbeiten; Artikel und Sammlungen verschieben
    • content:publish: Inhalte veröffentlichen, die Veröffentlichung aufheben, wiederherstellen und in den Papierkorb verschieben (Änderungen live schalten)
    • analytics:read: Hilfecenter-Berichte, Analysen und Artikel-Feedback lesen
    • conversations:read: Unterhaltungen und Transkripte des KI-Assistenten lesen
    • webhooks:manage: Ausgehende Webhook-Abonnements erstellen und verwalten

    Die Vergabe von content:write oder content:publish beinhaltet content:read. Vor der Einführung von Scopes ausgestellte Schlüssel haben null Scopes = vollständiger Zugriff (Legacy-Modus).

Query Parameters

  • page_size integer

    Anzahl der pro Seite zurückzugebenden Elemente (1–100). Beispiel: 20

  • start_cursor string

    Intransparenter Cursor für die Paginierung. Übergeben Sie den next_cursor aus einer vorherigen Antwort, um die nächste Seite abzurufen. Beispiel: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

  • status string

    Nach Aufgabenstatus filtern. Beispiel: completed

Response

application/json
  • results[] object array

    Elemente auf dieser Seite. Aufgaben-Payload.

    + Show Child Attributes
    • id string

      Aufgaben-ID (tsk_...).

    • title string | null

      Aufgabentitel. Wenn beim Erstellen nicht angegeben, generiert Fern nach der Aufgabenerstellung einen Titel.

    • status string

      Verarbeitungsstatus der Aufgabe.

  • has_more boolean

    Gibt an, ob nach dieser Seite weitere Elemente verfügbar sind.

  • next_cursor string | null

    Cursor, der als start_cursor für die nächste Seite übergeben wird, oder null auf der letzten Seite.