Documentation officielle pour SCOLANA
API Contacts
API “CONTACTS”
Préréquis
- La fonctionnalité “API” est activée sur votre Scolana
- Vous connaissez votre clé API (ci-dessous
api_key
).
Guide
https://<votre scolana>.scolana.com/api/contacts?key=api_key
La requête renvoie un objet en format JSON avec les deux clés suivantes :
contacts
: une liste de personnes, maximum 50 par pagemeta
: numéro de la page, nombre de pages total
Chaque élément de la liste contacts
contient, entre autres, les clés suivantes :
id
: l’identifiant interne de la fichefirst
: prénomlast
: nom de familleemail
: adresse maildob
: date de naissancecreated_at
: date et heure création ficheupdated_at
: date et heure dernière mise à jour
L’object meta
fournit quelques informations concernant la liste, notamment le nombre d’éléments au total, le nombre de pages au total (avec 50 éléments par page), et le numéro de la page en cours
page
: le numéro de cette pagetotal_pages
: nombre de pages disponiblescount
: nombre d’éléments dans la base