/mymission

L'endpoint /mymission permet de récupérer vos missions

Récupérer toutes vos missions

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

Via cette route, vous pouvez récupérer vos missions disponibles dans l'API.

Query Parameters

Name Type Description

Name	Type	Description
`limit`	`string`	Nombre maximal de résultats à retourner en une seule fois.
`skip`	`string`	Nombre de résultats à omettre avant de commencer à retourner les résultats.

limit

string

Nombre maximal de résultats à retourner en une seule fois.

skip

string

Nombre de résultats à omettre avant de commencer à retourner les résultats.

Headers

Name Type Description

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

apikey requis

string

La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

"ok": true,
    "total": 8638,
    "limit": 50,
    "skip": 50,
    "data": [
        {
            "_id": "xxxxxxxxxxxxxxxxxx",
            "organizationStatusJuridique": "Association",
            "country": "FR",
            "metadata": "",
            "activity": "communication",
            "city": "",
            "lastSyncAt": "2021-04-23T13:06:01.707Z",
            "organizationLogo": "https://jeveuxaider.com/publiRNYTPIju.png",
            "departmentCode": 33,
            "description": "Dans le cadre de cette mission, plusieurs besoins ont été identifiés."
            "remote": "full",
            "title": "J’accompagne des projets de communication",
            "organizationId": "",
            "createdAt": "2021-01-25T06:09:12.197Z",
            "publisherId": "xxxxxxxxxxxxxxxxxx",
            "publisherLogo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/xxxxxxxxxxxxxxxxxx/logo",
            "startAt": "2024-02-01T00:00:00.000Z",
            "updatedAt": "2024-04-23T13:09:40.707Z",
            "departmentName": "Gironde",
            "audience": [
                "parents",
                "children"
            ],
            "clientId": 45922,
            "address": ",  ",
            "organizationName": "Droits des Lycéens",
            "organizationUrl": "https://www.jeveuxaider.gouv.fr/organisations/xxxxxxxxxxxxxxxxxx",
            "priority": "",
            "publisherUrl": "https://www.jeveuxaider.gouv.fr/",
            "openToMinors": "yes",
            "schedule": "1 heure par semaine",
            "organizationFullAddress": "22 Avenue de Barricot, 33610 Canéjan, France",
            "places": "5",
            "deletedAt": null,
            "deleted": false,
            "postedAt": "2024-01-25T00:05:02.000Z",
            "publisherName": "JeVeuxAider.gouv.fr",
            "domain": "benevolat-competences",
            "applicationUrl": "https://www.jeveuxaider.gouv.fr/missions-benevolat/xxxxxxxxxxxxxxxxxx/",
            "statusCode": "ACCEPTED",
            "moderations": [],
            "snu": false,
            "descriptionHtml": "<p>Dans le cadre de cette mission, plusieurs besoins ont été identifiés. Vous pourrez intervenir sur l’un de ces sujets, en fonction de vos disponibilités et compétences :&nbsp;</p><ul><li>Assurer la production de contenus (articles, newsletters, posts sur les réseaux sociaux ou encore des vidéos)</li><li>Contribuer à la définition de la stratégie de communication de notre structure</li><li>Entretenir ou initier des contacts avec les médias et journalistes pertinents</li><li>Concevoir et diffuser des communiqués/dossiers de presse</li></ul><p><strong>Compétences souhaitées&nbsp;</strong></p><ul><li>Aisance rédactionnelle et relationnelle</li><li>Créativité</li><li>Maîtrise appréciée d’outils spécifiques (e-mailing, PAO, etc)</li><li>Bonnes capacités rédactionnelles</li></ul>\\n\\nObjectifs: \\n<p>En lien avec les autres membres de notre structure, votre rôle sera de contribuer au développement de la communication interne et/ou externe de notre organisation.</p>"
        },

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

Récupérer votre mission via votre ID

GET https://api.api-engagement.beta.gouv.fr/v0/mymission/:clientId

Récupérer votre mission avec votre ID tel qu'importé dans l'API. Si la requête retourne un statut 404, veuillez revérifier l'ID utilisé.

Path Parameters

Name Type Description

Name	Type	Description
`clientID`	`string`	Votre identifiant unique interne

clientID

string

Votre identifiant unique interne

Headers

Name Type Description

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

apikey requis

string

La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

{
    "ok": true,
    "data": {
        "_id": "xxxxxxxxxxxxxxxxxx",
        "activity": "sensibilisation",
        "applicationUrl": "https://api.api-engagement.beta.gouv.fr/r/xxxxxxxxxxxx",
        "audience": [
            "children",
            "any_public",
            "persons_with_disabilities"
        ],
        "clientId": 48153,
        "description": "Les bénévoles sont formés pour mieux connaitre le handicap et savoir animer les\nateliers en milieu scolaire. Les interventions ont lieu pendant les périodes et\nhoraires scolaires. En dehors des interventions les  bénévoles peuvent prendre\npart à des ateliers pour faire évoluer les ateliers et des rencontres avec les\néquipes enseignantes pour préparer les interventions. Les interventions pourront\navoir lieu dans les écoles du département.\n\n\\n\\nObjectifs: \\n\n\nAnimation d'ateliers destinés à faire découvrir le handicap, les difficultés des\npersonnes en situation de handicap, les gestes pour les aider. Le but étant de\nfaire changer le regard sur le handicap dès le plus jeune âge (de la maternelle\nau secondaire). Tous les types de handicap sont abordés à travers des débats et\ndes ateliers de mise en situation.Le programme pédagogique conçu par LADAPT\ns'appuie sur l'utilisation de la Handi'Mallette produite par l'association.",
        "domain": "education",
        "domainLogo": "https://jeveuxaider.com/public.webp",
        "metadata": "",
        "openToMinors": "no",
        "organizationUrl": "https://www.jeveuxaider.gouv.fr/",
        "organizationId": "",
        "organizationName": "Réseau des Réussites LADAPT Nouvelle Aquitaine",
        "organizationFullAddress": "Cénac, 33360 Cénac, France",
        "organizationStatusJuridique": "Association",
        "places": "3",
        "postedAt": "2022-03-07T17:51:29.000Z",
        "priority": "",
        "remote": "no",
        "schedule": "2 jours par mois",
        "startAt": "2022-03-08T09:00:00.000Z",
        "title": "J'anime des ateliers de sensibilisation au handicap en milieu scolaire",
        "deleted": false,
        "deletedAt": null,
        "lastSyncAt": "2022-04-23T13:06:01.707Z",
        "publisherId": "xxxxxxxxxxxxxxxxxx",
        "publisherName": "JeVeuxAider.gouv.fr",
        "publisherLogo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/xxxxxxxxxxx/logo",
        "publisherUrl": "https://www.jeveuxaider.gouv.fr/",
        "statusCode": "ACCEPTED",
        "updatedAt": "2022-04-23T13:09:41.157Z",
        "country": "FR",
        "location": {
            "lon": 1.2097174,
            "lat": 45.8213423
        },
        "address": ",  ",
        "city": "Limoges",
        "postalCode": "87000",
        "departmentCode": 87,
        "departmentName": "Haute-Vienne",
        "region": "Nouvelle-Aquitaine",
        "createdAt": "2022-03-11T16:06:41.913Z",
        "snu": false,
        "descriptionHtml": "<p>Les bénévoles sont formés pour mieux connaitre le handicap et savoir animer les ateliers en milieu scolaire. Les interventions ont lieu pendant les périodes et horaires scolaires. En dehors des interventions les &nbsp;bénévoles peuvent prendre part à des ateliers pour faire évoluer les ateliers et des rencontres avec les équipes enseignantes pour préparer les interventions. Les interventions pourront avoir lieu dans les écoles du département.</p>\\n\\nObjectifs: \\n<p>Animation d&#039;ateliers destinés à faire découvrir le handicap, les difficultés des personnes en situation de handicap, les gestes pour les aider. Le but étant de faire changer le regard sur le handicap dès le plus jeune âge (de la maternelle au secondaire). Tous les types de handicap sont abordés à travers des débats et des ateliers de mise en situation.Le programme pédagogique conçu par LADAPT s&#039;appuie sur l&#039;utilisation de la Handi&#039;Mallette produite par l&#039;association.</p>",
        "stats": {
            "applications": [],
            "clicks": []
        }
    }
}

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

Récupérez les statistiques de vos missions

GET https://api.api-engagement.beta.gouv.fr/v0/mymission/:clientId/stats

Retourne les statistiques de clics et de redirections d'une mission. Pour des raisons de RGPD, nous ne renvoyons pas de détails en dessous de 12

Path Parameters

Name Type Description

Name	Type	Description
`clientID`	`string`	Votre identifiant unique interne

clientID

string

Votre identifiant unique interne

Headers

Name Type Description

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

apikey requis

string

La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

{
    "ok": true,
    "data": {
        "clicks": [
            {
                "key": "Benevolt",
                "doc_count": "lessthan12"
            },
            {
                "key": "Google for job",
                "doc_count": "lessthan12"
            },
            {
                "key": "HelloAsso",
                "doc_count": "lessthan12"
            }
        ],
        "applications": []
    }
}

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

Previous/mission Next/view/stats

Last updated 6 months ago