Récupérer la liste de mes partenaires diffuseurs

Récupérer la liste de l'ensemble des partenaires qui diffusent vos missions et redirigent du traffic vers votre site.

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

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

200

{
    "ok": true,
    "data": [
        {
            "_id": "partenaire_id_1",
            "name": "Mon partenaire diffuseur 1",
            "category": "OTHER",
            "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 missions par widget
            "api": true, // Diffuse des missions par API
            "campaign": true, // Diffuse par campagne
            "annonceur": true, // Est annonceur de missions
            "excludedOrganizations": [
                {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_1_client_id",
                    "organisationName": "mon_organisation_1_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                },
                {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_2_client_id",
                    "organisationName": "mon_organisation_2_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                }
            ]
        },
        {
            "_id": "partenaire_id_2",
            "name": "Mon partenaire diffuseur 2",
            "category": "OTHER",
            "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": true,
            "annonceur": false,
            "excludedOrganizations": [
                {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_2_client_id",
                    "organisationName": "mon_organisation_2_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                },
                {
                    "publisherId": "mon_id",
                    "publisherName": "mon_nom",
                    "organizationClientId": "mon_organisation_4_client_id",
                    "organisationName": "mon_organisation_4_name",
                    "_id": "id_de_l_exclusion",
                    "createdAt": "2025-03-20T15:51:28.320Z", // Date de l'exclusion
                    "updatedAt": "2025-03-20T15:51:28.320Z"
                }
            ]
        },
        [...]
    ],
    "total": 15
}

401 Unauthorized

Unauthorized

501 Internal Server Error

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