API
Export des missions (API Partenaires)
GET https://api.benevolt.fr/v1/directory/mission
Export des missions (API Partenaires)
GET https://api.benevolt.fr/v1/directory/mission
Parameters
X-API-KEY en header ou avec le paramètre api_key en query.Query
| Name | Value | Description |
|---|---|---|
cursor | retourné par le premier appel API | Pour afficher la suite des résultats (remplace la pagination) |
per_page | nombre | Nombre de missions à retourner Par défaut : 100 |
api_key | api_key | Clé d'authentification (donnée par Benevolt) |
id | id d'une ou plusieurs missions (séparés par une virgule) | id Benevolt d'une mission |
template | id d'un ou plusieurs templates de mission (séparés par une virgule) | id Benevolt d'un template de mission |
Response
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "'regular' or 'punctual'",
"title": "Titre de la mission",
"description": "Description de la mission",
"infos": "Informations pratiques de la mission",
"duration": "Durée de la mission, si mission régulière",
"frequency": "Fréquence de la mission, si mission régulière",
"activity_type": {
"slug": "Slug du type d'activité",
"name": "Nom du type d'activité"
},
"organization": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Nom de la structure",
"local_id": "1234", // si la structure est liée à compte chez le partenaire
"local_name": "Nom de la structure chez le partenaire", // si la structure est liée à compte chez le partenaire
"avatar_url": "https://storage.benevolt.fr/00000000-0000-0000-0000-000000000000/c/avatar.jpg",
"domain": {
"slug": "Slug du domaine de l'association",
"name": "Nom du domaine de l'association"
},
"location": {
"poi": null,
"address": "Adresse de l'association",
"zipcode": "Code Postal de l'association",
"city": "Ville de l'association",
"city_code": "Code Insee de la ville de l'association",
"coordinates": {
"lat": 0.00000,
"lng": -0.00000
},
"country": "France",
"country_code": "fr"
},
"location_txt": "Adresse complète de l'association",
"url": "https://benevolat.monasso.org/association/mon-asso"
},
"active_sessions": [
{
"id": "00000000-0000-0000-0000-000000000000",
"start_date": "2023-02-13T14:00:00+01:00", // optionnel si mission de type 'regular'
"end_date": "2023-02-13T16:00:00+01:00", // `null` si mission de type 'regular'
"remote": false,
"location": {
"poi": null,
"address": "Adresse de la mission",
"zipcode": "Code Postal de la mission",
"city": "Ville de la mission",
"city_code": "Code Insee de la ville de la mission",
"coordinates": {
"lat": 0.00000,
"lng": -0.00000
},
"country": "France",
"country_code": "fr"
},
"location_txt": "Lieu de la mission à afficher sur la card de résultat", // adapté si regroupe plusieurs annonces dans plusieurs lieux
"date_txt": "À partir du 13 février 2023, 2 créneaux", // adapté si regroupe plusieurs créneaux
"title": "Nom de la ville",
"slots": null, // nombre de places, si mission ponctuelle avec inscription
"remaining_slots": null, // nombre de places restantes, si mission ponctuelle avec inscription
"url": "https://benevolat.monasso.org/association/mon-asso/ma-mission-000000000000"
}
],
"template" : "null", // ou "00000000-0000-0000-0000-000000000000"
}
],
"path": "https://api.benevolt.fr/v1/search/mission", // n'ajoute pas automatiquement les paramètres GET
"per_page": 12,
"next_cursor": 'xxxxxxxxxx', // à passer dans l'attribut cursor pour avoir les prochains résultats
"prev_cursor": null
}