Civic Engagement APIAPI Engagement

API EngagementCivic Engagement API

APIDiscovered1/7blocked by verifiedPreviewSubscribe🇫🇷France

API Engagement is a free public digital service provided by the French Government that allows organizations to publish and distribute volunteering and civic service opportunities across France. It aggregates and broadcasts missions from various platforms, making it easier for associations, public bodies, and volunteering networks to share their opportunities widely without duplicating listing efforts. The service is aimed at organizations seeking to increase the visibility of their volunteering and civic engagement missions, as well as platforms wishing to display a broader range of opportunities to their users, supporting the national effort to promote volunteering and civic participation throughout France.L'API Engagement permet aux organisations de publier et diffuser des annonces de bénévolat et de volontariat. ### A quoi sert l’API Engagement ? L’API Engagement facilite la diffusion des missions de bénévolat et de volontariat partout en France. C’est un service public numérique gratuit qui perm…

digital

OpenAPI spec Read the docs Visit homepage

Trust score

How is this computed?

good

Weighted across five axes. Tap a ring for what it measures.

Data schema (95 fields)

Filterable via the API (28)

clientIdidtypelimitskipkeywordsdomainactivityremotelatlondistancecitydepartmentNamecountrypublisherorganizationRNAorganizationStatusJuridiqueopenToMinorsreducedMobilityAccessiblestartAtcreatedAtqrnasiretorganizationClientIdfieldvalue

Field	Type	Description
clientIdClient id	string	Identifier of the mission in the publisher's own system.Identifiant de la mission dans votre système
id	string	Internal identifier or client event ID of the activity.Identifiant interne ou "clientEventId" de l'activité
type	string	Type of activity, required if the client event ID is ambiguous.Type de l'activité (requis en cas d'ambiguïté sur le "clientEventId")
limit	integer	Maximum number of results to return (default 25, max 10,000).Nombre de résultats (défaut 25, max 10 000)
skip	integer	Number of results to skip for pagination.Décalage pour la pagination
keywords	string	Free text search across title, description, and organization.Recherche textuelle (titre, description, organisation)
domain	string	Field or domain of action for the mission.Domaine d'action
activity	string	Activity proposed within the mission.Activité proposée
remote	string	Remote work policy: no, possible, full, or local.Politique de télétravail : no, possible, full, local
lat	number (double)	Latitude used for geographic search, required with longitude.Latitude (requis avec "lon" pour la recherche géographique)
lon	number (double)	Longitude used for geographic search, required with latitude.Longitude (requis avec "lat" pour la recherche géographique)
distance	string	Search radius for geographic filtering, e.g. 25km or 50km.Rayon de recherche géographique (ex. 25km, 50km). Défaut : 50km
city	string	Filter results by city.Filtre par ville
departmentNameDepartment name	string	Filter results by department name.Filtre par département
country	string	Filter results by country.Filtre par pays
publisher	string	Filter by identifiers of publishing partners.Filtre sur les identifiants de partenaires diffuseurs
organizationRNAOrganization rna	string	Filter by the organization's RNA registration number.Filtre par numéro RNA de l'organisation
organizationStatusJuridiqueOrganization status juridique	string	Filter by the organization's legal status.Filtre par forme juridique de l'organisation
openToMinorsOpen to minors	string	Filter for missions open only to minors.Missions ouvertes aux mineurs uniquement
reducedMobilityAccessibleReduced mobility accessible	string	Filter for missions accessible to people with reduced mobility.Missions accessibles PMR uniquement
startAtStart at	string	Filter on the mission's start date, e.g. >2024-01-01.Filtre sur la date de début (ex. >2024-01-01, <2024-12-31)
createdAtCreated at	string	Filter on the record's creation date, e.g. >2024-01-01.Filtre sur la date de création (ex. >2024-01-01)
q	string	Free text search on the name field.Recherche textuelle sur le nom
rna	string	Exact RNA registration number.Numéro RNA exact
siretSIRET (establishment)	string	Exact SIRET business identification number.Numéro SIRET exact
organizationClientIdOrganization client id	string	Identifier of the organization in the publisher's own system.Identifiant de l'organisation dans votre système
field	string	Field name to evaluate diffusion against, used with value.Champ sur lequel évaluer la diffusion. À fournir conjointement avec `value`. Valeurs possibles : `type`, `publisherOrganizationId`, `publisherOrganization.clientId`, `publisherOrganization.parentOrganizations`.
value	string	Value to search for in the specified field.Valeur recherchée sur le champ `field`. À fournir conjointement avec `field`.
streetAddress	string	Street number and name of the address.Numéro et nom de rue
postalCodeAddress	string	Postal code of the address.Code postal
departmentCodeAddress	string	Department code, e.g. 75, 69, 2A.Code du département (ex. 75, 69, 2A)
regionAddress	string	Name of the region.Nom de la région
publisherIdMission	string	Identifier of the advertising partner.Identifiant du partenaire annonceur
statusCodeMission	string	Moderation status assigned by JeVeuxAider.Statut de modération JeVeuxAider
statusCommentMission	string	Comment associated with the moderation status.Commentaire associé au statut de modération
titleMission	string	Title of the mission.Titre de la mission
descriptionMission	string	Full description of the mission, in plain text or HTML.Description complète de la mission. Texte brut ou HTML acceptés. La valeur fournie est conservée pour le rendu riche. Si du HTML est fourni, elle est aussi convertie en texte brut pour les usages internes, la recherche et la modération. Recommandations : - Utiliser le format HTML pour une meil
applicationUrlMission	string (uri)	URL of the page where users apply for the mission.URL de la page où l'utilisateur sera redirigé pour candidater (URL de la page présentant la mission)
imageMission	string (uri)	URL of the mission's image.URL de l'image de la mission. Si absent, l'API Engagement utilise une image de sa bibliothèque selon le domaine.
metadataMission	string	Free-form metadata associated with the mission.Métadonnées libres associées à la mission.
activitiesMission	array<string>	Main activities involved in the mission.Activité(s) principale(s) de la mission. Valeurs possibles : `accueil-de-public`, `aide-psychologique`, `activites-manuelles`, `alphabetisation`, `animation`, `Animation, Valorisation`, `art`, `autre`, `bricolage`, `collecte`, `communication`, `comptabilite-finance`, `conseil`, `distribution`, `docu
tagsMission	array<string>	Custom keywords used to tag the mission.Mots-clés personnalisés pour taguer la mission. Chaque élément du tableau est un tag distinct.
audienceMission	array<string>	Beneficiaries or public targeted by the mission.Les bénéficiaires de la mission — à qui la mission s'adresse, le public auquel sera confronté la personne qui s'engage.
requirementsMission	array<string>	Prerequisites required to take part in the mission.Pré-requis relatifs à la mission.
softSkillsMission	array<string>	General soft skills required for the mission.Les compétences générales requises pour la mission. Ce champ ne repose pas sur un référentiel de compétence structuré.
romeSkillsMission	array<string>	ROME 4.0 macro skill codes associated with the mission.Code OGR Macro du ROME 4.0. Ce champ repose sur le référentiel "Arborescence simplifiée des compétences" (section "Arborescence du ROME").
scheduleMission	string	Free text describing the mission's schedule or rhythm.Rythme de la mission (texte libre)
endAtMission	string (date-time)	Desired end date of the mission, in ISO 8601 format.Date de fin de la mission souhaitée. Format ISO 8601. Défaut : now()
postedAtMission	string (date-time)	Date the mission was first published, in ISO 8601 format.Date de première publication de la mission. Format ISO 8601.
placesMission	integer	Number of available places for the mission.Nombre de places disponibles pour la mission. Ce nombre doit être mis à jour dès qu'il évolue dans votre système afin que l'API Engagement dispose toujours de la donnée la plus récente.
compensationAmountMission	number	Minimum compensation amount received by the volunteer.Montant minimum de l'indemnisation perçue par le bénévole ou le volontaire. Utilisé seul ou comme borne basse d'une fourchette avec `compensationAmountMax`.
compensationAmountMaxMission	number	Maximum compensation amount, forming the upper bound of a range.Montant maximum de l'indemnisation. Si renseigné, `compensationAmount` est la borne basse et `compensationAmountMax` la borne haute (ex. 0–13 €/h). Doit être supérieur ou égal à `compensationAmount`.
compensationUnitMission	string	Time period the compensation amount refers to: year, month, day, or hour.Période de l'indemnisation pour le montant fourni. Valeurs possibles : `year`, `month`, `day`, `hour`
compensationTypeMission	string	Type of compensation: gross or net.Type d'indemnisation. Valeurs possibles : `gross` (brut), `net` (net)
addressesMission	array<object>	List of locations where the mission takes place.Ensemble des localisations où se déroule la mission. Si la mission se tient dans plusieurs lieux, renseignez autant d'objets que de localisations. Pour une mission en lieu unique, le tableau ne contient qu'un seul objet.
organizationNameMission	string	Name of the organization.Nom de l'organisation. Requis si un autre champ `organization*` est renseigné.
organizationDescriptionMission	string	Description of the organization.Description de l'organisation.
organizationUrlMission	string (uri)	Website link of the organization.Lien de l'organisation (ex. page de présentation sur votre site).
organizationTypeMission	string	Type of the organization.Type de l'organisation.
organizationLogoMission	string (uri)	URL of the organization's logo image.URL de l'image de l'organisation.
organizationSirenMission	string	SIREN business registration number of the organization.SIREN de l'organisation.
organizationSiretMission	string	SIRET business identification number of the organization.SIRET de l'organisation.
organizationFullAddressMission	string	Free-text address of the organization.Adresse de l'organisation. Pas de format strict attendu (contrairement à l'adresse de la mission).
organizationPostCodeMission	string	Postal code of the organization.Code postal de l'organisation.
organizationCityMission	string	City where the organization is located.Ville de l'organisation.
organizationBeneficiariesMission	array<string>	Beneficiaries served by the organization.Bénéficiaires de l'organisation.
organizationActionsMission	array<string>	Main actions carried out by the organization.Principales actions menées par l'organisation.
organizationReseauxMission	array<string>	Network the organization belongs to, if part of a national network.Réseau de l'organisation. Ce champ sert à renseigner les organisations ayant des antennes locales et dépendant d'un réseau national.
updatedAtMission	string (date-time)	Date and time of the last modification.Date de dernière modification
deletedAtMission	string (date-time)	Date and time the record was soft-deleted.Date de suppression (soft delete)
keyMissionStatsBucket	string	Identifier of the publishing partner.Identifiant du partenaire diffuseur
nameMissionStatsBucket	string	Name of the publishing partner.Nom du partenaire diffuseur
doc_countMissionStatsBucket	integer	Number of events counted.Nombre d'événements
clicksMissionStats	array<object>	Clicks recorded on the mission, grouped by publishing partner.Clics vers la mission, par partenaire diffuseur
applicationsMissionStats	array<object>	Applications recorded for the mission, grouped by publishing partner.Candidatures enregistrées, par partenaire diffuseur
_idActivity	string	Identifier of the activity record.Identifiant de l'activité
statusActivity	string	Status of the application.Statut de la candidature
clickIdActivity	string	Identifier of the originating click event.Identifiant du clic d'origine
missionClientIdActivity	string	Client-side identifier of the related mission.Identifiant client de la mission concernée
missionIdActivity	string	Internal identifier of the related mission.Identifiant interne de la mission
tagActivity	string	Free-form tag associated with the event.Tag libre associé à l'événement
categoryPartner	string	Category of the partner.Catégorie du partenaire
urlPartner	string (uri)	Website of the partner.Site web du partenaire
logoPartner	string (uri)	URL of the partner's logo.URL du logo
widgetPartner	boolean	Indicates whether the partner has widget access rights.Le partenaire dispose de droits widget
apiPartner	boolean	Indicates whether the partner has API access rights.Le partenaire dispose de droits API
campaignPartner	boolean	Indicates whether the partner has campaign access rights.Le partenaire dispose de droits campagne
annonceurPartner	boolean	Indicates whether the partner is an advertiser publishing missions.Le partenaire est annonceur (publie des missions)
fieldTypeDiffusionRule	string	Data type of the evaluated value, defaults to string.Type de la valeur évaluée (par défaut `string`)
operatorDiffusionRule	string	Comparison operator used in the diffusion rule.Opérateur de comparaison. Valeurs possibles : `is`, `is_not`, `contains`, `does_not_contain`, `starts_with`, `is_greater_than`, `is_less_than`, `exists`, `does_not_exist`.
rulesDiffuseurWithRules	array<object>	Diffusion rules configured for this partner.Règles de diffusion configurées pour ce diffuseur
diffuseDiffuseurWithRules	boolean	Indicates whether the partner would diffuse the searched value.Présent uniquement lorsque les paramètres `field` et `value` sont fournis. Indique si ce diffuseur diffuserait la valeur recherchée : `false` si une règle d'exclusion (`does_not_contain`, `is_not`, `does_not_exist`) sur ce champ l'exclut, `true` sinon.
okError	boolean	Indicates whether the request was successful.Indicates whether the request was successful.
codeError	string	Error code identifying the type of error.Error code identifying the type of error.
messageError	unknown	Details of the error, as text or a structured object.Détail de l'erreur (peut être un objet Zod ou une chaîne)

Schema captured from openapi 20 days ago.

Verification Status

Using the API

Configuration

Base URL: https://api.api-engagement.beta.gouv.fr

License

Terms stated by the source (not a recognized license):

MIT

Query examples

curl -s 'https://raw.githubusercontent.com/betagouv/api-engagement/main/api/docs/openapi.yaml' -H 'Accept: application/json'

Machine-readable API description (use it to generate clients).

Full API documentation ↗

Machine-readable & source

OpenAPI spec JSON

Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.