/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
Name | Type | Description |
---|---|---|
|
| Filtrer sur le nom du département |
|
| Filtrer sur le pays |
|
| Filtrer sur l'activité (cf. Les constantes). Vous pouvez en indiquer plusieurs en les séparant par une virgule "," |
|
| Filtrer sur la ville |
|
| Filtrer sur le partenaire. Vous pouvez en indiquer plusieurs en les séparant par une virgule "," |
|
| Filtrer sur le domaine (cf. Les constantes). Vous pouvez en indiquer plusieurs en les séparant par une virgule "," |
|
| Filtrer sur le type |
|
| Nombre de résultats à omettre avant de commencer à retourner les résultats. |
|
| Nombre maximal de résultats à retourner en une seule fois. |
|
| Filtrer sur la mission à distance ou non (cf. Les constantes). |
Headers
Name | Type | Description |
---|---|---|
|
| 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
Name | Type | Description |
---|---|---|
|
| Recherche par texte dans les champs |
|
| Taille des données que vous souhaitez récupérer. Utile pour la pagination. |
|
| Définir à partir d’où vous souhaitez récupérer la donnée que vous récoltez. Utile pour la pagination |
|
| Latitude de la mission. Doit être utilisée avec les champs |
|
| Longitude de la mission. Doit être utilisée avec les champs |
|
| Distance autour de la latitude et de la longitude. Défaut à 50km. |
|
| Vous pouvez récupérer des missions uniquement ouvertes aux mineurs. La valeur de champ peut être |
|
| Vous pouvez récupérer des missions uniquement accessibles aux personnes à mobilité réduite. La valeur de champ peut être |
|
| Vous pouvez filtrer sur un domaine en particulier |
|
| Vous pouvez filtrer sur une activité |
|
| Vous pouvez filtrer sur un département. |
|
| Vous pouvez trier les missions par date de création si vous choisissez de filtrer sur le champs |
|
| Obtenez des missions créées avant ou après certaines dates. ex : {{baseUrl}}/v0/mission/search?createdAt=gt:2021-11-10T04:24:33.866Z |
|
| Faites une recherche en fonction du compte annonceur. Si vous souhaitez en mentionner plusieurs, séparez leurs noms par des |
|
| 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 |
|
| Vous pouvez récupérer des missions uniquement proposées à distance. La valeur de champ peut être " |
Headers
Name | Type | Description |
---|---|---|
|
| 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
Name | Type | Description |
---|---|---|
|
| Identifiant de la mission |
Récupération des statistiques sur les missions
GET
https://api.api-engagement.beta.gouv.fr/v0/stats
Query Parameters
Name | Type | Description |
---|---|---|
|
| Facets à retourner pour enrichir vos requêtes. ex : facets=domain,activity,publisherName |
|
| La date de création. Avant ( ex : createdAt=gt:2022-03-25&createdAt=lt:2022-05-25 |
Last updated