Klantly Developers

API-Referenz

Labels

Die Labels, die Ihr Unternehmen für Karten eingerichtet hat, z. B. HEISS oder GESCHÄFTLICH. Setzen Sie sie mit Labels eines Deals ändern auf einen Deal.

Endpunkte

Labels abrufen

GET /api/v1/deal-labels

Alle Labels Ihres Unternehmens in der Reihenfolge der Pipeline-Einstellungen. Labels verwalten Sie in Klantly selbst.

Scope
deals.read — Deals und Pipeline-Phasen lesen
Erforderliche Funktion
pipeline

Beispielanfrage

cURL
curl "https://app.klantly.com/api/v1/deal-labels" \
  -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', 'deal-labels');

$data = json_decode((string) $response->getBody(), true)['data'];
JavaScript
const response = await fetch('https://app.klantly.com/api/v1/deal-labels', {
  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/deal-labels",
    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": "deal_label",
      "id": "4b8e2c10-7d3a-4f6e-9a1b-2c3d4e5f6a70",
      "name": "HEET",
      "color": "#DC2626",
      "group": "Urgentie"
    }
  ],
  "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 "deal_label".
id string (uuid) Eindeutige Id (UUID).
name string Name des Labels, z. B. HEISS.
color string Farbe auf dem Board (Hex).
group string Labels derselben Gruppe schließen sich aus (ein Deal ist HEISS oder FRÜHJAHR); null = kombinierbar mit allem. kann leer sein (null)