Skip to content

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 ​

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query ​

NomTypeRequisDescription
idCompanyint|int[]conditionnelIdentifiant(s) de la société
sirenString|String[]conditionnelNuméro(s) SIREN
pollingintconditionnelMin. 15 (minutes)
idUserint|int[]nonIdentifiant(s) d'utilisateur (doivent appartenir au compte)
idCommentTypeint|int[]nonType(s) de commentaire
minCommentDatedatetimenonDate de début (format YYYY-mm-DD)
maxCommentDatedatetimenonDate 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
json
{
    "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
json
{
    "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
json
{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}
403 — Forbidden
json
{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}

Coefficy — API externe