Référence de l'API
Étapes du pipeline
Les étapes de votre tableau de pipeline, dans l'ordre, et si une étape signifie ouvert, gagné ou perdu.
Endpoints
Lister les étapes du pipeline
GET
/api/v1/pipeline-stages
Toutes les étapes actives du tableau de pipeline, dans l'ordre du tableau. Les noms dans les quatre langues figurent sous names.
- Scope
-
deals.read— Lire les affaires et les étapes du pipeline - Fonctionnalité requise
pipeline
Exemple de requête
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"]Réponse 200
La réponse est une liste avec pagination par curseur : data contient les objets, meta la pagination.
{
"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
}
}Erreurs possibles
-
403
insufficient_scope— Cette clé API n'a pas accès à cette action.
L'objet
Tous les champs sont toujours présents ; un champ sans valeur vaut null.
| Champ | Type | Description |
|---|---|---|
object |
string | Toujours « pipeline_stage ». |
id |
string | Id de l'étape. |
name |
string | Nom dans la langue de la requête. |
names |
object | Le nom dans les quatre langues. |
names.nl |
string | Nom néerlandais. peut être vide (null) |
names.en |
string | Nom anglais. peut être vide (null) |
names.de |
string | Nom allemand. peut être vide (null) |
names.fr |
string | Nom français. peut être vide (null) |
type |
string | open (ouvert), won (gagné) ou lost (perdu) : un deal dans cette étape reçoit ce statut. l'une des valeurs : open, won, lost |
is_default |
boolean | Les nouveaux deals arrivent dans cette étape. |
position |
integer | Position sur le tableau, de gauche à droite. |
probability |
string | Probabilité de gain en pourcentage, sous forme de texte à deux décimales. |
color |
string | Couleur sur le tableau (hex). peut être vide (null) |