Klantly Developers

API-referentie

Takenborden

De borden met hun kolommen. De kolom bepaalt de status van een taak.

Endpoints

Takenborden opvragen

GET /api/v1/task-boards

Alle takenborden met hun kolommen, van links naar rechts. Heeft het bedrijf nog geen bord, dan maakt Klantly het standaardbord aan.

Scope
tasks.read — Taken, borden en reacties lezen
Vereiste functie
tasks

Voorbeeldverzoek

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

Antwoord 200

Het antwoord is een lijst met cursorpaginering: data bevat de objecten, meta de paginering.

Voorbeeldantwoord
{
  "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
  }
}

Mogelijke fouten

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Het object

Alle velden zijn altijd aanwezig; een veld zonder waarde is null.

VeldTypeOmschrijving
object string Altijd "task_board".
id string (uuid) Id van het bord.
name string Naam van het bord.
is_default boolean Het standaardbord; nieuwe taken zonder kolom komen hier.
statuses array<object> De kolommen, van links naar rechts.
statuses.object string Altijd "task_status".
statuses.id string (uuid) Id van de kolom (voor status_id).
statuses.name string Naam van de kolom.
statuses.category string Wat de kolom betekent: open, in_progress, completed of cancelled. een van: open, in_progress, completed, cancelled
statuses.color string Kleur van de kolom (hex). kan leeg zijn (null)
statuses.position integer Plaats op het bord, van links naar rechts.
statuses.is_default boolean De standaardkolom voor zijn soort.