Récupérer votre mission par identifiant

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.

Récupérer une mission avec ses statistiques

get

/v0/mymission/{clientId}

Retourne une mission identifiée par son "clientId" ainsi que ses statistiques d'engagement (clics, candidatures, créations de compte).

Authorizations

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Path parameters

clientIdstringRequired

Identifiant de la mission dans votre système

Example: mission-2024-001

Responses

200

Mission avec statistiques

application/json

okbooleanOptionalExample: true

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

404

Ressource introuvable

application/json

get/v0/mymission/{clientId}

GET /v0/mymission/{clientId} HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Accept: */*

{
  "ok": true,
  "data": {
    "id": "64a1b2c3d4e5f6789abc0001",
    "clientId": "mission-bénévolat-2024-001",
    "publisherId": "5f5931496c7ea514150a818f",
    "statusCode": "ACCEPTED",
    "title": "Animateur bénévole en maison de retraite",
    "applicationUrl": "https://example.org/missions/001/postuler",
    "domain": "sante",
    "activities": [
      "animation",
      "accompagnement"
    ],
    "audience": [
      "seniors",
      "personnes-isolees"
    ],
    "remote": "no",
    "schedule": "2 heures par semaine le samedi matin",
    "places": 5,
    "openToMinors": "yes",
    "reducedMobilityAccessible": "yes",
    "addresses": [
      {
        "street": "12 rue de la Paix",
        "zip": "75001",
        "city": "Paris",
        "department": "75",
        "departmentName": "Paris",
        "region": "Île-de-France",
        "country": "France",
        "location": {
          "lat": 48.8698,
          "lon": 2.3303
        }
      }
    ],
    "organizationName": "Croix-Rouge française",
    "organizationRNA": "W751206979",
    "organizationSiren": "775672272",
    "organizationSiret": "77567227221138",
    "organizationUrl": "https://www.croix-rouge.fr",
    "createdAt": "2024-01-15T09:00:00.000Z",
    "updatedAt": "2024-03-01T14:30:00.000Z",
    "_id": "text",
    "activity": "text",
    "publisherName": "text",
    "publisherUrl": "https://example.com",
    "publisherLogo": "https://example.com",
    "domainLogo": "https://example.com",
    "postedAt": "2026-01-01T00:00:00.000Z",
    "duration": 1,
    "location": {
      "lat": 1,
      "lon": 1
    },
    "stats": {
      "clicks": [
        {
          "key": "5f5931496c7ea514150a818f",
          "name": "JeVeuxAider.gouv.fr",
          "doc_count": 42
        }
      ],
      "applications": [
        {
          "key": "5f5931496c7ea514150a818f",
          "name": "JeVeuxAider.gouv.fr",
          "doc_count": 42
        }
      ]
    }
  }
}