<aside> ☝ Cette API est constituée d’un ensemble d’endpoints qui permettent de lire, créer et modifier des offres collectives dites “réservables” et non les offres collectives vitrines.

<aside> ℹ️ Pour tout savoir sur le pass Culture collectif à destination des groupes scolaires RDV sur l'espace dédié de la FAQ.

</aside>

Cadre d’utilisation de l’API

Les offres collectives créées par API et le portail pass Culture pro

Les offres collectives créées par API sont visibles sur le portail pass Culture pro. En revanche, ces offres ne sont pas manuellement éditables sur le portail pass Culture pro, à l’exception de quelques actions :

Schémas et Swagger

L’ensembles des endpoints et schémas sont détaillés dans le swagger.

Lien vers le swagger d’intégration :

Swagger UI

Lien vers le swagger de production :

Swagger UI

En parallèle, une documentation plus détaillée du fonctionnement de l’API ainsi que l’illustration des schémas de base de données par des exemples est fournie ci-après.

Formats

dates

Les dates sont présentées au format ISO 8601: https://fr.wikipedia.org/wiki/ISO_8601

📌 Les dates sont stockées en UTC-0 et affichées dans l’UTC de l’utilisateur.

prix

Tous les prix sont exprimés en en euro (€). Ils sont exprimés avec jusqu’à deux chiffres après la virgule.

erreurs

⚠️ Les messages d’erreurs tels que présentés ci-dessous ne sont pas harmonisés dans leur forme.