Pour accéder à des données générales concernant les agendas indexés sur la plateforme, utilisez la route suivante:
https://api.openagenda.com/v2/agendas?key={key}&size={size}&after={after}
Les informations récupérables sur cette route sont:
- Les informations définissant l'agenda: Titre, description, image, url, identifiant (uid)
- Les paramétrages de contribution
- La définition des champs constituant son formulaire événement
- Un résumé de contenu
Paramètres
| Clé |
Description |
Exemple |
| key |
clé publique d'un compte OpenAgenda |
?key=ru479iouzr84refh |
| size |
nombre d'agendas à récupérer par appel |
?size=100 |
| after |
Clé de pagination fournie dans la réponse de l'appel précédant pour récupérer le lot suivant de résultats |
|
| fields |
Préciser les champs additionnels à faire remonter (summary, schema) |
?fields[]=summary |
Filtres
| Clé |
Description |
Exemple |
| search |
Recherche libre sur le titre, la géographie et les mots clés dominants référencés dans l'agenda |
?search=Normandie |
| official |
Limiter les résultats aux agendas officiels |
?official=1 |
| slug |
Filtrer sur des slug donnés |
?slug[]=metropole-europeenne-de-lille&slug[]=mieux-se-deplacer-a-bicyclette |
| uid |
Filtrer sur des identifiants donnés |
?uid[]=89904399&uid[]=16904082 |
| network |
Filtrer sur un réseau d'agendas |
?network=97678557 |
Tris
| Clé |
Description |
Exemple |
| createdAt.desc |
Trier les agendas du plus récent au plus ancien |
?sort=createdAt.desc |
| recentlyAddedEvents.desc |
Les agendas avec des événements contribués récemment (7 derniers jours) s'affichent en premier |
|