Types de rendez-vous

Lister les types de rendez-vous#

Tous les types de rendez-vous de l’entreprise dans l’ordre de l’écran, y compris les inactifs (voir is_active).

Scope

appointments.read — Lire les rendez-vous (avec le nom, l'e-mail et le téléphone du client), les types de rendez-vous et les disponibilités

Fonctionnalité requise

appointments

Exemple de requête

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

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

const response = await fetch('https://app.klantly.com/api/v1/appointment-types', {
  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/appointment-types",
    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": "appointment_type",
      "id": "9d3f7ea4-5a9c-4b1f-8e6d-7c8a9bacbdc5",
      "name": "Inmeten",
      "names": {
        "nl": "Inmeten",
        "en": "Measuring",
        "de": "Aufmaß",
        "fr": "Prise de mesures"
      },
      "description": null,
      "duration_minutes": 60,
      "price": "49.50",
      "color": "#3B82F6",
      "is_active": true
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Erreurs possibles

• 403 insufficient_scope — Cette clé API n'a pas accès à cette action.

En outre, chaque endpoint peut renvoyer les erreurs générales, comme une clé invalide ou une limite atteinte. Voir tous les codes d'erreur.

L'objet#

Tous les champs sont toujours présents ; un champ sans valeur vaut null.