Rechercher dans les missions

Rechercher dans les missions de vos partenaires avec des filtres précis. A noter que vous récupérez des facets sur certains champs

GET https://api.api-engagement.beta.gouv.fr/v0/mission/search

Vous pouvez retrouver le modèle de données des missions ici

Query Parameters

Name	Type	Description
activity	string	Filtrer sur l'activité. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
city	string	Filtrer sur la ville. 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 ","
country	string	Filtrer sur le pays
createdAt	gt:Date / lt:Date	Filtrer sur la date de création de la mission Ex: "gt:2021-11-10T04:24:33.866Z"
departmentName	string	Filtrer sur le nom du département. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
distance	string	Distance autour de la latitude et de la longitude. Il est possible de preciser l'unité avec "m" ou "km". Défaut à "50km" Ex: "5km","5000m"
domain	string	Filtrer sur le domaine. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
keywords	string	Chercher par un keyword a dans les champs title, organizationName, publisherName et city
limit	number	Nombre maximal de résultats à retourner en une seule fois.
lat	number	Filtrer par localisation autour dans un cercle de rayon distance avec cette latitude, nécessite lon
lon	number	Filtrer par localisation autour dans un cercle de rayon distance avec cette longitude, nécessite lat
organizationRNA	string	Filtrer sur l'organisation. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
organizationStatusJuridique	string	Filtrer sur la forme juridique de l'organisation. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
openToMinors	string	Filtrer sur l'ouverture aux mineurs. "yes" ou "no"
publisher	string	Filtrer sur le partenaire. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","
remote	string	Filtrer sur la mission à distance ou non
reducedMobilityAccessible	string	Filtrer sur l'accessibilité aux personnes à mobilité réduite. "yes" ou "no"
skip	number	Nombre de résultats à omettre avant de commencer à retourner les résultats.
startAt	gt:Date / lt:Date	Filtrer sur la date de début de la mission Ex: "gt:2021-11-10T04:24:33.866Z"
type	string	Filtrer sur le type

Headers

Name	Type	Description
x-api-key requis	string	La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

200 OK

{
    "ok": true,
    "total": 912,
    "hits": Mission[],
    "facets": {
        "departmentName": [
            {
                "key": "Côtesd'Armor",
                "doc_count": 16
            },
            {
                "key": "Finistère",
                "doc_count": 13
            },
            [...]
        ],
        "activities": [
            {
                "key": "",
                "doc_count": 17
            },
            {
                "key": "autre",
                "doc_count": 11
            },
            {
                "key": "mentorat-parrainage",
                "doc_count": 10
            },
            [...]
        ],
        "domains": [
            {
                "key": "solidarite-insertion",
                "doc_count": 21
            },
            {
                "key": "benevolat-competences",
                "doc_count": 18
            },
            [...]
        ]
    }
}

400 Bad Request

{
    "ok": false,
    "code": "INVALID_QUERY",
    "message": {
        "issues": [
            {
                "received": "true",
                "code": "invalid_enum_value",
                "options": [
                    "yes",
                    "no"
                ],
                "path": [
                    "openToMinors"
                ],
                "message": "Invalid enum value. Expected 'yes' | 'no', received 'true'"
            }
        ],
        "name": "ZodError"
    }
}

401 Unauthorized

Unauthorized

500 Internal Server Error

{
    "ok": false,
    "code": "SERVER_ERROR"
}