/association
L'API association facilite la recherche, la consultation et la mise à jour de la base des établissements liés aux associations. Une association contient un ou plusieurs établissements.
Rechercher des établissements
POST
https://api.api-engagement.beta.gouv.fr/v1/association/search
Retourne les établissements via le nom de l'établissement.
Headers
apikey
requis
string
La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.
Request Body
name
string
Nom de l'association recherchée
minScore
number
Score de correspondance minimal attendu
city
string
Ville de l'association
size
number
Nombre de résultats maximum retournés
Mettre à jour un établissement
PUT
https://api.api-engagement.beta.gouv.fr/v1/association/:idRna/etablissement/:id
Enrichit les données d'un établissement au sein d'une association. Ces modifications permettent de mettre à jour un établissement sans modifier tous les établissement de l'association à laquelle il appartient. La modification de la description d'un établissement n'aura pas d'impact sur la description des autres établissement. Pour mettre à jour la description de toute une association, utiliser la route décrite plus bas.
Path Parameters
id
string
Identifiant de l'établissement
idRna
string
Identifiant de l'association.
Headers
apikey
requis
string
La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.
Request Body
facebook
string
URL facebook
linkedin
string
URL linkedin
logo
string
URL vers l'image du logo
url
string
Site web
twitter
string
URL twitter
description
string
description de l'établissement
publics_beneficiaires
array
Publics visés. Exemple : "Tous publics"
statut_juridique
string
Statut juridique
coordonnees
string
Objet représentant les coordonnées à destination du public de l'association. L'adresse respecte le format de l'API adresse. Exemple :
"coordonnees": {
"adresse": {
"nom_complet": "29 Rue Etienne Lemerle 44400 Rezé",
"nom": "29 Rue Etienne Lemerle",
"code_postal": "44400",
"code_insee": "44143",
"rue": "Rue Etienne Lemerle",
"numero": "29",
"commune": "Rezé",
"commune_ancienne": "",
"contexte": "44, Loire-Atlantique, Pays de la Loire",
"departement_numero": "44",
"departement": "Loire-Atlantique",
"region": "Pays de la Loire",
"type": "housenumber"
},
"telephone": [ "0683527271" ],
"courriel": []
}
domaines
array
Liste des domaines de l'association (ex: "Protection de la nature", "Mémoire et citoyenneté")
donation
string
URL pour les dons à l'association
Mettre à jour une association
PUT
https://api.api-engagement.beta.gouv.fr/v1/association/:idRna
Enrichir les données d'une association via son identifiant RNA. Ces modifications seront appliquées sur tous les établissements.
Path Parameters
idRna
string
ID RNA
Headers
apikey
requis
string
La clé API nécessaire à l’authentification.
Request Body
coordonnees
object
Objet représentant les coordonnées à destination du public de l'association. L'adresse respecte le format de l'API adresse.
Exemple :
"coordonnees": {
"adresse": {
"nom_complet": "29 Rue Etienne Lemerle 44400 Rezé",
"nom": "29 Rue Etienne Lemerle",
"code_postal": "44400",
"code_insee": "44143",
"rue": "Rue Etienne Lemerle",
"numero": "29", "commune": "Rezé",
"commune_ancienne": "",
"contexte": "44, Loire-Atlantique, Pays de la Loire",
"departement_numero": "44",
"departement": "Loire-Atlantique",
"region": "Pays de la Loire",
"type": "housenumber"
},
"telephone": [ "0683527271" ],
"courriel": []
}
donation
string
URL pour les dons à l'association
domaines
array
Liste des domaines de l'association (ex: "Protection de la nature", "Mémoire et citoyenneté")
statut_juridique
string
Statut juridique
publics_beneficiaires
array
Publics visés (ex: "Tous publics")
description
string
Description de l'association
url
string
URL du site de l'association
facebook
string
URL facebook de l'association
twitter
string
URL twitter de l'association
linkedin
string
URL linkedin de l'association
logo
string
URL du logo (JPEG, PNG) de l'association
Liste des établissement d'une association
GET
https://api.api-engagement.beta.gouv.fr/v1/association/:idRna
Lister les établissements d'une association
Path Parameters
idRna
string
ID RNA
Headers
apikey
requis
string
La clé API nécessaire à l’authentification.
Obtenir un établissement
GET
https://api.api-engagement.beta.gouv.fr/v1/association/:idRna/etablissement/:id
Obtenir les infos sur un établissement en particulier
Path Parameters
idRna
string
Identifiant de l'association
id
string
Identifiant de l'établissement
Headers
apikey
requis
string
La clé API nécessaire à l’authentification.
Liste des champs d'un établissement
Les différentes routes renvoient les informations suivantes (elles peuvent être manquantes quand elles ne sont pas renseignées)
_id
Identifiant de l'établissement
rna
Identifiant RNA
name
Nom de l'association
regime
Exemple : "loi1901"
theme
Exemple : "Sport", "Environnement et patrimoine", "Loisirs et vie sociale"
famille
Exemple : "préservation du patrimoine", "Sports, activités de plein air"
commune
Exemple: "Nantes", "Paris"
objet
Objet de l'association (texte descriptif)
coordonnees
(Objet) Coordonnées de l'association (voir exemples au dessus)
logo
URL vers le logo de l'association (PNG, JPEG)
url
URL vers le site de l'association
linkedin
URL vers la page linkedIn de l'association
facebook
URL vers la page facebook de l'association
twitter
URL vers la page twitter de l'association
donation
URL vers le site de donation
domaines
Liste des domaines de l'association (ex: "Protection de la nature", "Mémoire et citoyenneté")
publics_beneficiaires
Publics visés (ex: "Tous publics")
statut_juridique
Statut juridique
description
Description de l'association
score
Score (uniquement dans le cas d'une recherche)
Last updated