Récupérer les partenaires diffuseurs d'une organisation

Récupère la liste des partenaires diffuseurs associés à une organisation via son identifiant client.

Consulter la diffusion d'une organisation

get

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v0/myorganization/{organizationClientId}

Retourne la liste des partenaires diffuseurs éligibles, avec pour chacun :

• le nombre de clics vers les missions de cette organisation sur les 30 derniers jours
• l'indicateur d'exclusion éventuelle

Utile pour piloter la stratégie de diffusion d'une organisation.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Path parameters

organizationClientIdstringRequired

Identifiant de l'organisation dans votre système

Example: org-croix-rouge-001

Responses

200

Liste des partenaires diffuseurs avec statut d'exclusion

application/json

okbooleanOptionalExample: true

totalintegerOptionalExample: 8

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

404

Ressource introuvable

application/json

get

/v0/myorganization/{organizationClientId}

HTTPcURLJavaScriptPython

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

{
  "ok": true,
  "total": 8,
  "data": [
    {
      "_id": "5f5931496c7ea514150a818f",
      "name": "JeVeuxAider.gouv.fr",
      "category": "Plateforme gouvernementale",
      "url": "https://www.jeveuxaider.gouv.fr",
      "description": "La plateforme officielle du bénévolat en France",
      "widget": true,
      "api": true,
      "campaign": false,
      "annonceur": false,
      "excluded": true,
      "clicks": 1
    }
  ]
}