Klantly Developers

Référence de l'API

Tableaux de tâches

Les tableaux avec leurs colonnes. La colonne détermine le statut d’une tâche.

Endpoints

Lister les tableaux de tâches

GET /api/v1/task-boards

Tous les tableaux de tâches avec leurs colonnes, de gauche à droite. Si l’entreprise n’a pas encore de tableau, Klantly crée le tableau par défaut.

Scope
tasks.read — Lire les tâches, les tableaux et les commentaires
Fonctionnalité requise
tasks

Exemple de requête

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"]

Réponse 200

La réponse est une liste avec pagination par curseur : data contient les objets, meta la pagination.

Exemple de réponse
{
  "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
  }
}

Erreurs possibles

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

L'objet

Tous les champs sont toujours présents ; un champ sans valeur vaut null.

ChampTypeDescription
object string Toujours « task_board ».
id string (uuid) Id du tableau.
name string Nom du tableau.
is_default boolean Le tableau par défaut ; les nouvelles tâches sans colonne y arrivent.
statuses array<object> Les colonnes, de gauche à droite.
statuses.object string Toujours « task_status ».
statuses.id string (uuid) Id de la colonne (pour status_id).
statuses.name string Nom de la colonne.
statuses.category string Ce que signifie la colonne : open, in_progress, completed ou cancelled. l'une des valeurs : open, in_progress, completed, cancelled
statuses.color string Couleur de la colonne (hex). peut être vide (null)
statuses.position integer Position sur le tableau, de gauche à droite.
statuses.is_default boolean La colonne par défaut de sa catégorie.