Klantly Developers

API-Referenz

Aufgabenboards

Die Boards mit ihren Spalten. Die Spalte bestimmt den Status einer Aufgabe.

Endpunkte

Aufgabenboards auflisten

GET /api/v1/task-boards

Alle Aufgabenboards mit ihren Spalten, von links nach rechts. Hat das Unternehmen noch kein Board, erstellt Klantly das Standardboard.

Scope
tasks.read — Aufgaben, Boards und Kommentare lesen
Erforderliche Funktion
tasks

Beispielanfrage

cURL
curl "https://app.klantly.com/api/v1/task-boards" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"
PHP
$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'task-boards');

$data = json_decode((string) $response->getBody(), true)['data'];
JavaScript
const response = await fetch('https://app.klantly.com/api/v1/task-boards', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();
Python
import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/task-boards",
    headers={
        "Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
    },
)
data = response.json()["data"]

Antwort 200

Die Antwort ist eine Liste mit Cursor-Paginierung: data enthält die Objekte, meta die Paginierung.

Beispielantwort
{
  "data": [
    {
      "object": "task_board",
      "id": "9d3f80e6-7cbe-4d3b-8a8f-9eacbdcedfe7",
      "name": "Algemeen",
      "is_default": true,
      "statuses": [
        {
          "object": "task_status",
          "id": "9d3f8207-8dcf-4e4c-9b9a-afbdcedfe0f8",
          "name": "Open",
          "category": "open",
          "color": "#3B82F6",
          "position": 1,
          "is_default": true
        }
      ]
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Mögliche Fehler

Zusätzlich kann jeder Endpunkt die allgemeinen Fehler zurückgeben, etwa einen ungültigen Schlüssel oder ein erreichtes Limit. Alle Fehlercodes ansehen.

Das Objekt

Alle Felder sind immer vorhanden; ein Feld ohne Wert ist null.

FeldTypBeschreibung
object string Immer „task_board“.
id string (uuid) ID des Boards.
name string Name des Boards.
is_default boolean Das Standardboard; neue Aufgaben ohne Spalte landen hier.
statuses array<object> Die Spalten, von links nach rechts.
statuses.object string Immer „task_status“.
statuses.id string (uuid) ID der Spalte (für status_id).
statuses.name string Name der Spalte.
statuses.category string Was die Spalte bedeutet: open, in_progress, completed oder cancelled. einer von: open, in_progress, completed, cancelled
statuses.color string Farbe der Spalte (Hex). kann leer sein (null)
statuses.position integer Position auf dem Board, von links nach rechts.
statuses.is_default boolean Die Standardspalte ihrer Art.