Skip to main content
La ressource Events permet de gérer les séances de votre agenda par programmation. Utilisez-la pour synchroniser une billetterie ou un outil de planification, importer une programmation en masse ou automatiser les mises à jour.

Points de terminaison


GET /events — Lister les événements

Renvoie la liste paginée des événements du projet.

Paramètres de requête

string
Filtre les résultats selon l’identifiant textuel de la catégorie. Seuls les événements de cette catégorie sont renvoyés.
string
Date au format ISO 8601. Renvoie uniquement les événements commençant à cette date ou après.
string
Date au format ISO 8601. Renvoie uniquement les événements se terminant à cette date ou avant.
integer
Nombre maximal de résultats par page. Valeur par défaut : 50. Maximum : 200.
integer
Nombre de résultats à ignorer pour la pagination. Valeur par défaut : 0.

Exemple de requête

Exemple de réponse


POST /events — Créer un événement

Crée un événement dans l’agenda du projet.

Paramètres du corps

string
required
Titre de l’événement affiché au public.
string
required
Date et heure de début au format ISO 8601.
string
required
Date et heure de fin au format ISO 8601.
string
Identifiant textuel de la catégorie de l’événement, par exemple music ou sport.
string
Identifiant du lieu à associer à l’événement. Il doit correspondre à un id valide de la ressource Lieux.
string
Description textuelle de l’événement.

Exemple de requête


GET /events/ — Consulter un événement

Renvoie un événement à partir de son identifiant.

Exemple de requête


PUT /events/ — Modifier un événement

Modifie un événement existant. Incluez uniquement les champs à modifier. Les autres conservent leur valeur.

Paramètres du corps

La requête PUT accepte les mêmes champs que POST /events. Tous les champs sont facultatifs.

Exemple de requête


DELETE /events/ — Supprimer un événement

Supprime définitivement un événement. Cette action est irréversible.

Exemple de requête

Renvoie 204 No Content en cas de succès.