✒️
Documentation API Engagement
API Reference
API Reference
  • API REFERENCE
    • Introduction
    • Authentification
    • Errors
  • MISSION (/mission)
    • Récupérer des missions
    • Rechercher dans les missions
    • Récupérer une mission avec l'identifiant
  • MES MISSIONS (/mymission)
    • Récupérer vos missions
    • Récupérer votre mission avec l'identifiant de la mission
    • Récupérer les statistiques d'une mission
  • PERFORMANCE (/view)
    • Récupérer des statistiques sur vos missions
  • DIFFUSEUR (/publisher)
    • Récupérer la liste de mes partenaires diffuseurs
    • Récupérer les informations d'un partenaire diffuseur avec son identifiant
  • MES ORGANISATIONS (/myorganization)
    • Récupérer la liste des partenaires diffuseurs pour une organisation
    • Modifier les partenaires diffuseurs d'une organisation
  • Organisation (/organization)
    • Récupérer les organisations
Powered by GitBook
On this page
  1. MES MISSIONS (/mymission)

Récupérer votre mission avec l'identifiant de la mission

Récupérer les données de la mission correspondant à l’identifiant fourni en paramètre, avec un champ "stats" indiquant le nombre de candidatures et de redirections générées.

PreviousRécupérer vos missionsNextRécupérer les statistiques d'une mission

Last updated 2 months ago

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

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

Path Parameters

Name
Type
Description

clientId

String

Identifiant de la mission

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.

{
    "ok": true,
    "data":{
        "_id": "mission_id",
        "clientId": "12345",
        "activity": "mentorat-parrainage",
        "addresses": [
            {
                "street": "Saint-Paul",
                "city": "Saint-Paul",
                "postalCode": "97411",
                "departmentName": "La Réunion",
                "departmentCode": "974",
                "region": "La Réunion",
                "country": "FR",
                "location": {
                    "lat": -21.0097,
                    "lon": 55.2697
                },
                "geoPoint": {
                    "type": "Point",
                    "coordinates": [
                        55.2697,
                        -21.0097
                    ],
                    "_id": "_id"
                },
                "geolocStatus": "ENRICHED_BY_PUBLISHER",
                "_id": "_id"
            }
        ],
        "applicationUrl": "https://api.api-engagement.beta.gouv.fr/r/mission_id/publisher_id",
        "audience": [
            "children",
            "any_public"
        ],
        "closeToTransport": "no",
        "createdAt": "2021-05-11T09:07:59.000Z",
        "deleted": false,
        "deletedAt": null,
        "description": "Description de la mission",
        "descriptionHtml": "<p>Description de la mission</p>",
        "domain": "education",
        "domainLogo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/img/generique.jpeg",
        "endAt": null,
        "lastSyncAt": "2025-03-05T14:01:21.576Z",
        "metadata": "",
        "openToMinors": "no",
        "organizationActions": [],
        "organizationBeneficiaries": [],
        "organizationCity": "organization_city",
        "organizationClientId": "6789",
        "organizationDescription": "",
        "organizationFullAddress": "organization_address",
        "organizationId": "organization_id",
        "organizationLogo": "organization_logo",
        "organizationName": "organization_name",
        "organizationPostCode": "organization_postcode",
        "organizationRNA": "W1234567890",
        "organizationReseaux": [],
        "organizationSiren": "",
        "organizationStatusJuridique": "Association",
        "organizationType": "",
        "organizationUrl": "organization_url",
        "places": 4,
        "postedAt": "2021-05-11T09:07:59.000Z",
        "priority": "",
        "publisherId": "publisher_id",
        "publisherLogo": "publisher_logo",
        "publisherName": "publisher_name",
        "publisherUrl": "publisher_url",
        "reducedMobilityAccessible": "no",
        "remote": "no",
        "schedule": "1 heure",
        "snu": false,
        "snuPlaces": null,
        "softSkills": [],
        "startAt": "2020-11-16T08:00:00.000Z",
        "statusCode": "ACCEPTED",
        "statusComment": "",
        "statusCommentHistoric": [
            {
                "status": "ACCEPTED",
                "comment": "",
                "date": "2024-10-07T07:01:48.188Z",
                "_id": "_id"
            }
        ],
        "tags": [
            "tag_1"
        ],
        "tasks": [],
        "title": "Titre de la mission",
        "updatedAt": "2025-03-05T14:02:34.758Z",
        "stats": {
            "applications": [
                {
                    "key": "publisher_id_1",
                    "name": "publisher_name_1",
                    "doc_count": 13
                },
                {
                    "key": "publisher_id_2",
                    "name": "publisher_name_2",
                    "doc_count": 8
                },
                [...]
            ],
            "clicks": [
                {
                    "key": "publisher_id_1",
                    "name": "publisher_name_1",
                    "doc_count": 67
                },
                {
                    "key": "publisher_id_2",
                    "name": "publisher_name_2",
                    "doc_count": 48
                },
                [...]
            ]
        }
    }
}
{
    "ok":false,
    "code":"NOT_FOUND"
}
{
    "ok": false,
    "code": "SERVER_ERROR"
}
ici