Klantly Developers

Référence de l'API

Utilisateurs

Les utilisateurs de votre entreprise, par exemple pour attribuer un deal à quelqu'un.

Endpoints

Lister les utilisateurs

GET /api/v1/users

Les utilisateurs de votre entreprise, triés par id. Utilisez l'id comme assigned_user_id d'un deal.

Scope
users.read — Lire les utilisateurs de l'entreprise

Paramètres de requête

NomTypeDescription
limit integer Nombre de résultats par page. de 1 à 100 · par défaut : 50
cursor string Le next_cursor ou prev_cursor de meta dans la réponse précédente.
filter[status] string Uniquement les utilisateurs actifs ou uniquement les utilisateurs désactivés. l'une des valeurs : active, inactive

Exemple de requête

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

$data = json_decode((string) $response->getBody(), true)['data'];
JavaScript
const response = await fetch('https://app.klantly.com/api/v1/users', {
  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/users",
    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.

Exemple de réponse
{
  "data": [
    {
      "object": "user",
      "id": "7",
      "name": "Sanne Bakker",
      "email": "sanne@devriesbouw.nl",
      "role": "Verkoop",
      "is_owner": false,
      "status": "active",
      "created_at": "2026-09-14T10:15:00Z"
    }
  ],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Erreurs possibles

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.

ChampTypeDescription
object string Toujours « user ».
id string Id de l'utilisateur.
name string Nom.
email string (email) Adresse e-mail.
role string Nom du rôle dans votre entreprise, ou null sans rôle. peut être vide (null)
is_owner boolean Le propriétaire du compte.
status string active ou inactive (désactivé). l'une des valeurs : active, inactive
created_at string (date-time) Créé le (UTC).