search

Récupérer la liste des partenaires diffuseurs pour une organisation

Récupérer la liste des partenaires diffuseurs d'une organisation, avec pour chacun un statut précisant s'il est "inclus" ou "exclu" de la diffusion chez le diffuseur.

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

hashtag
Path Parameters

Name
Type
Description

organizationClientId

String

Identifiant de l'organisation. L'identifiant doit être le même qui est utilisé dans le flux XML dans le champs organizationClientIdlors du partage des missions.

hashtag
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.

Response

{
    "ok": true,
    "data": [
        {
            "_id": "partenaire_id_1",
            "name": "Partenaire 1",
            "category": "OTHERS",
            "url": "https://www.partenaire1.fr",
            "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/partenaire_id_1/logo",
            "description": "La description de mon partenaire",
            "widget": false, // Ne diffuse pas de mission par widget
            "api": true, // Diffuse des missions par API
            "campaign": true, // Diffuse par campagne
            "annonceur": true, // Est annonceur de missions
            "excluded": true, // L'organisation n'est pas diffusée chez ce partenaire diffuseur
            "clicks": 56 // Nombre de redirections que ce partenaire a générer pour l'organisation sur les 30 derniers jours
        },
        {
            "_id": "partenaire_id_2",
            "name": "Partenaire 2",
            "category": "PUBLICS_SERVICES",
            "url": "https://www.partenaire2.fr",
            "logo": "https://api-engagement-bucket.s3.fr-par.scw.cloud/publishers/partenaire_id_2/logo",
            "description": "La description de mon partenaire",
            "widget": true,
            "api": false,
            "campaign": false,
            "annonceur": true,
            "excluded": false,
            "clicks": 42
        },
        [...]
    ]
}
PreviousRécupérer les informations d'un partenaire diffuseur avec son identifiantNextModifier les partenaires diffuseurs d'une organisation

Last updated