Pipeline-Phasen

Pipeline-Phasen auflisten#

Alle aktiven Phasen des Pipeline-Boards, in der Reihenfolge des Boards. Die Namen in allen vier Sprachen stehen unter names.

Scope

deals.read — Deals und Pipeline-Phasen lesen

Erforderliche Funktion

pipeline

Beispielanfrage

curl "https://app.klantly.com/api/v1/pipeline-stages" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

$client = new \GuzzleHttp\Client([
    'base_uri' => 'https://app.klantly.com/api/v1/',
    'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);

$response = $client->request('GET', 'pipeline-stages');

$data = json_decode((string) $response->getBody(), true)['data'];

const response = await fetch('https://app.klantly.com/api/v1/pipeline-stages', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

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

import os

import requests

response = requests.get(
    "https://app.klantly.com/api/v1/pipeline-stages",
    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.

{
  "data": [
    {
      "object": "pipeline_stage",
      "id": "3",
      "name": "Offerte verstuurd",
      "names": {
        "nl": "Offerte verstuurd",
        "en": "Quote sent",
        "de": "Angebot gesendet",
        "fr": "Devis envoyé"
      },
      "type": "open",
      "is_default": false,
      "position": 3,
      "probability": "50.00",
      "color": "#3B82F6"
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Mögliche Fehler

• 403 insufficient_scope — Dieser API-Schlüssel hat keinen Zugriff auf diese Aktion.

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.