Commentaires

Permet de récupérer les éléments de timeline (commentaires, appels, emails…) associés à une société.

Récupérer les commentaires

GET /v1/comment

Retourne la liste des éléments de timeline d'une société. Chaque élément référence son contenu via idReferenceElement et son type via idTimelineElementType.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idCompany	int|int[]	conditionnel	Identifiant(s) de la société
siren	String|String[]	conditionnel	Numéro(s) SIREN
polling	int	conditionnel	Min. 15 (minutes)
idUser	int|int[]	non	Identifiant(s) d'utilisateur (doivent appartenir au compte)
idCommentType	int|int[]	non	Type(s) de commentaire
minCommentDate	datetime	non	Date de début (format YYYY-mm-DD)
maxCommentDate	datetime	non	Date de fin (format YYYY-mm-DD)

TIP

Au moins un des paramètres idCompany, siren ou polling est obligatoire.

WARNING

Seul idCompany est réellement appliqué comme filtre actuellement. Les paramètres siren, polling, idUser, idCommentType, minCommentDate et maxCommentDate sont acceptés et validés (erreur 400 si format invalide), mais ne filtrent pas les résultats. Utilisez idCompany.

Réponses

200 — OK

{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "polling": "int|null",
        "idUser": "int[]|null",
        "idCommentType": "int[]|null",
        "minCommentDate": "datetime|null",
        "maxCommentDate": "datetime|null"
    },
    "commentList": [
        {
            "idTimelineElement": "int",
            "idReferenceElement": "int",
            "idTimelineElementType": "int",
            "date": "datetime",
            "idAccount": "string",
            "idCompany": "int|null",
            "idAccountHours": "int|null",
            "created": "datetime",
            "modified": "datetime"
        }
    ]
}

Notes :

• idTimelineElementType indique la nature de l'élément (commentaire, appel, email…) ; idReferenceElement est l'identifiant de l'élément référencé dans sa table d'origine.
• Le texte du commentaire n'est pas inclus dans cette réponse.

400 — Bad Request

{
    "success": false,
    "message": "Paramètre idCompany, siren ou polling nécessaire",
    "parameters": {}
}

Autres messages possibles : "Utilisateur introuvable", format de date invalide pour minCommentDate/maxCommentDate.

401 — Unauthorized

{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

403 — Forbidden

{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}