/mission
L'endpoint /mission permet de récupérer les missions qui vous sont disponibles
Récupérer des missions de vos partenaires
Récupération de toutes les missions
GET
https://api.api-engagement.beta.gouv.fr/v0/mission
Récupérer toutes les missions de vos partenaires. A noter que vous récupérez, en plus des résultats demandés, le nombre total de résultats disponibles
Query Parameters
departmentName
string
Filtrer sur le nom du département
country
string
Filtrer sur le pays
activity
string
city
string
Filtrer sur la ville. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
publisher
string
Filtrer sur le partenaire. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
domain
string
associationId
string
Filtrer sur les associations par identifiant. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
associationRNA
string
Filtrer sur les associations par nom. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
clientId
string
Filtrer sur les identifiants partenaires des mission. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
type
string
Filtrer sur le type
skip
number
Nombre de résultats à omettre avant de commencer à retourner les résultats.
limit
number
Nombre maximal de résultats à retourner en une seule fois.
remote
string
Headers
apikey
requis
string
La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.
Rechercher parmi les missions de vos partenaires
GET
https://api.api-engagement.beta.gouv.fr/v0/mission/search?[parameters]
Récupérer les missions de vos partenaires en utilisant des filtres dans les paramètres. La réponse comporte les missions ainsi que les agrégations sur les domaines
Query Parameters
text
String
Recherche par texte dans les champs title
, description
, publisherName
et city
size
Number
Taille des données que vous souhaitez récupérer. Utile pour la pagination.
from
Number
Définir à partir d’où vous souhaitez récupérer la donnée que vous récoltez. Utile pour la pagination
lat
Float
Latitude de la mission. Doit être utilisée avec les champs lon
et distance
.
lon
Float
Longitude de la mission. Doit être utilisée avec les champs lat
et distance
.
distance
String
Distance autour de la latitude et de la longitude. La distance est prise par défaut en kilomètre, il est possible de preciser la distance en mètres ou kilomètres avec l'ajout d'unité "m"
ou "km"
à la fin. Exemple: "5"
= "5km"
= "5000m"
. Défaut à "50km".
openToMinors
String
Vous pouvez récupérer des missions uniquement ouvertes aux mineurs. La valeur de champ peut être "yes"
ou "no"
.
reducedMobilityAccessible
String
Vous pouvez récupérer des missions uniquement accessibles aux personnes à mobilité réduite. La valeur de champ peut être "yes"
ou "no"
.
domain
String
Vous pouvez filtrer sur un domaine en particulier
activity
String
Vous pouvez filtrer sur une activité
departmentName
String
Vous pouvez filtrer sur un département.
sortBy
String
Vous pouvez trier les missions par date de création si vous choisissez de filtrer sur le champs createdAt
.
Vous pouvez également n’afficher que des missions autour d’un point donné (voir les champs lon
et lat
) en organisant le tri en fonction de la localisation
du point. Si localisation est choisi, un champ _distance
est ajouté a chaque mission qui renseigne la distance en km du point renseigné
createdAt
Date
Obtenez des missions créées avant ou après certaines dates. ex : {{baseUrl}}/v0/mission/search?createdAt=gt:2021-11-10T04:24:33.866Z
publisher
String
Faites une recherche en fonction du compte annonceur. Si vous souhaitez en mentionner plusieurs, séparez leurs noms par des ","
startAt
Date
Obtenez des missions qui démarrent avant ou après certaines dates.
ex : {{baseUrl}}/v0/mission/search?startAt=gt:2021-11-10T04:24:33.866Z
remote
String
Vous pouvez récupérer des missions uniquement proposées à distance. La valeur de champ peut être "no"
, "possible"
ou "full"
.
Headers
apikey
requis
String
La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.
Récupération de missions dont l'ID est connu
GET
https://api.api-engagement.beta.gouv.fr/v0/mission/:id
Cette méthode vous permet de récupérer une mission via son ID
Path Parameters
id
String
Identifiant de la mission
Last updated