Pipelinefasen

Pipelinefasen opvragen#

Alle actieve fasen van het pipelinebord, in de volgorde van het bord. De namen in alle vier de talen staan onder names.

Scope

deals.read — Deals en pipelinefasen lezen

Vereiste functie

pipeline

Voorbeeldverzoek

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

Antwoord 200

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

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

Mogelijke fouten

• 403 insufficient_scope — Deze API-sleutel heeft geen toegang tot deze actie.

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.