Introduction
Grâce à votre token d’identification (API Token), vous pouvez interagir avec les listes auxquelles vous avez accès dans Kizeo Forms.
Vous pouvez notamment :
consulter les listes disponibles
accéder à leur structure
récupérer leurs éléments
ajouter, modifier ou supprimer des données
⚠️ Important : versions de l’API
La récupération des listes utilise l’API v3
Toutes les opérations sur les listes avancées utilisent l’API v4
👉 URL de base API v4 :
https://forms.kizeo.com/rest/v4
1. Récupérer les listes disponibles
Cette requête permet d’obtenir toutes les listes (externes et avancées) auxquelles vous avez accès.
Requête
GET https://forms.kizeo.com/rest/v3/lists
Résultat
Vous obtenez la liste des objets avec :
id: identifiant de la listename: nom de la listeis_advanced: indique si c’est une liste avancée
2. Obtenir la structure d’une liste avancée
Une fois l’ID de la liste récupéré, vous pouvez consulter sa structure.
Requête
GET https://forms.kizeo.com/rest/public/v4/lists/{listId}/definitionRésultat
Vous obtenez :
le nom de la liste
les propriétés (colonnes)
leur type (string, float…)
leur ordre
⚠️ Attention
Une erreur 404 List not found signifie :
soit que la liste n’est pas accessible avec votre token
soit que ce n’est pas une liste avancée
3. Récupérer les éléments d’une liste
Requête
GET https://forms.kizeo.com/rest/public/v4/lists/{listId}/itemsChaque élément contient :
idlabelpropertiescreated_atupdated_at
3.1 Options disponibles
🔹 search
Recherche dans le champ label (insensible à la casse)
?search=ABBANS
🔹 offset
Permet de décaler les résultats
?offset=1
👉 Le premier élément retourné sera le deuxième
🔹 limit
Nombre maximum d’éléments retournés
?limit=100
⚠️ Maximum : 500 éléments
🔹 sort + direction
Permet de trier les résultats
?sort=property_id&direction=asc
asc: ordre croissantdesc: ordre décroissant
⚠️ direction est obligatoire si sort est utilisé
4. Récupérer un élément spécifique
Requête
GET https://forms.kizeo.com/rest/public/v4/lists/{listId}/items/{itemId}Erreurs possibles
List not foundItem not found
5. Ajouter des éléments
Requête
POST https://forms.kizeo.com/rest/public/v4/lists/{listId}/itemsCorps de la requête
{
"items": [
{
"label": "Nom de l’élément",
"properties": {
"property_id1": "valeur",
"property_id2": 123
}
}
]
}
6. Modifier plusieurs éléments
Requête
PATCH https://forms.kizeo.com/rest/public/v4/lists/{listId}/itemsCorps de la requête
{
"items": [
{
"item_id": "ID",
"label": "Nouveau label",
"properties": {
"property_id1": "nouvelle valeur"
}
}
]
}⚠️ Règles importantes
item_idetlabelsont obligatoiresMaximum : 500 éléments par requête
Ne pas envoyer de champs vides (
""ounull)Les valeurs numériques ne doivent pas être entre guillemets
7. Modifier un seul élément
Requête
PATCH https://forms.kizeo.com/rest/public/v4/lists/{listId}/items/{itemId}Corps de la requête
{
"label": "Nouveau label",
"properties": {
"property_id1": "valeur"
}
}⚠️ Erreurs possibles
wrong_formatsunknown_propertiesList not foundServer Error(champ obligatoire manquant)
8. Supprimer un élément
Requête
DELETE https://forms.kizeo.com/rest/public/v4/lists/{listId}/items/{itemId}💡 Bonnes pratiques
Vérifiez toujours les IDs via la requête de listing
Testez vos requêtes avec Postman ou Swagger
Limitez les requêtes à 500 éléments maximum
Utilisez le tri (
sort) pour optimiser vos résultats
Conclusion
L’API Kizeo Forms vous permet de gérer facilement vos listes avancées :
lecture des données
modification en masse
intégration avec vos outils