Alertes
Permet de récupérer les alertes associées à une société.
Récupérer les alertes
GET/v1/alertRetourne la liste des alertes d'une société avec le statut, la diffusion, la catégorie, les contacts influenceurs/décisionnaires et l'historique des versions.
Headers
| Nom | Type | Requis | Description |
|---|---|---|---|
| x-access-token | String | oui | Clé API |
Paramètres query
| Nom | Type | Requis | Description |
|---|---|---|---|
| idCompany | int | conditionnel | Identifiant de la société. Obligatoire si siren n'est pas renseigné |
| siren | String | conditionnel | Numéro SIREN. Obligatoire si idCompany n'est pas renseigné |
| idAlert | int | non | Filtrer par identifiant d'alerte |
TIP
Au moins idCompany ou siren est obligatoire.
Réponses
200 — OK
json
{
"success": true,
"code": "200",
"message": "OK",
"parameters": {
"idCompany": "int|null",
"siren": "string|null",
"idAlert": "int|null"
},
"result": {
"alertList": [
{
"idAlert": "int",
"idCompany": "int",
"created": "datetime",
"modified": "datetime",
"status": "int",
"diffusion": "int",
"category": "int",
"description": "string",
"version": "int",
"statusObject": { "id": "int", "title": "string" },
"diffusionObject": { "id": "int", "title": "string" },
"categoryObject": { "id": "int", "title": "string" },
"tags": ["string"],
"influencers": ["<Contact>"],
"decisionMakers": ["<Contact>"],
"versionHistory": [
{
"version": "int",
"maturityLevel": "string",
"budget": "float|null",
"deadline": "datetime|null",
"createdBy": "string",
"created": "datetime"
}
]
}
]
}
}400 — Bad Request
json
{
"success": false,
"code": "400",
"message": "Au moins idCompany ou siren est requis"
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Clé API invalide"
}