Pagination, filtres et synchronisation

Parcourir des listes avec un curseur, filtrer et trier, et synchroniser les modifications.

Listes#

Une réponse de liste contient data (les objets) et meta (la pagination) :

{
  "data": [],
  "meta": {
    "limit": 50,
    "next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
    "prev_cursor": null
  }
}

Parcourir avec un curseur#

Demandez la page suivante avec le next_cursor de la réponse précédente :

curl "https://app.klantly.com/api/v1/customers?limit=100&cursor=eyJpZCI6IjlkM2Y2YzFlIn0" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"

Lorsque next_cursor vaut null, vous êtes sur la dernière page. Un curseur désigne une position dans le tri, pas un numéro de page : les enregistrements ajoutés entre-temps ne décalent rien. Si vous triez par updated_at, un enregistrement modifié pendant que vous parcourez les pages peut réapparaître plus loin ; dédoublonnez donc sur id. Un curseur appartient à un tri : ne l'utilisez pas avec un autre sort. limit va de 1 à 100 ; la valeur par défaut est 50.

Filtrer et rechercher#

Les filtres se placent dans filter[...], par exemple filter[status]=lead ou filter[email]=jan@example.com. Avec q, vous recherchez dans plusieurs champs à la fois. Les filtres disponibles sont indiqués pour chaque endpoint dans la référence de l'API. Un filtre inconnu renvoie une erreur de validation.

Trier#

sort=created_at trie par ordre croissant, sort=-created_at par ordre décroissant. Le tri décroissant par date de création est la valeur par défaut.

Synchroniser#

Pour tenir votre propre système à jour, récupérez régulièrement ce qui a changé :

1. Mémorisez le moment de votre synchronisation précédente.
2. Demandez filter[updated_since]=<ce moment>&sort=updated_at et parcourez toutes les pages.
3. Enregistrez le nouveau moment.

Dernière mise à jour le 15 septembre 2026