Endpoints / getLeadHistory

getLeadHistory

History eines Leads (Notes/Tasks/Status-Changes/Offers)

Chronologische Liste aller Events zu einem Lead. Filterbar nach Type (S/A/J/OFF) und Category.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/getLeadHistory

Auth basicAuth apiKey

Request Parameters

Type-Filter: leer = Notizen und Tasks, S = Status-/Folder-Wechsel, A = Assignee-Wechsel, J = Watcher join/leave, OFF = Angebot. null liefert alles.

Parameter	Pflicht	Typ	Beispiel / Default
`leadId`	required	integer
`type` S=Status, A=Anmerkung, J=Journal, OFF=Offer, leer/null=alle	optional	string enum: S \| A \| J \| OFF \|
`category`	optional	string
`includeDeleted`	optional	boolean	default: `false`
`offset`	optional	integer	default: `0`
`limit`	optional	integer	default: `100`

Response Parameters

Fehler: HTTP 400 Provide a valid leadId.

Field	Typ	Beschreibung
`status`	boolean	true bei Erfolg, false bei Fehler
`msg`	string	Kurzbeschreibung des Resultats / der Fehlerursache
`result`		Endpoint-spezifisches Resultat. Typ je nach Endpoint (Object, Array, Skalar oder null).
`pagination`		Nur bei Listen-Endpoints gesetzt

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/sales/getLeadHistory

Payload

{
    "leadId": 12345,
    "type": null,
    "category": null,
    "includeDeleted": false,
    "offset": 0,
    "limit": 100
}

Response

{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "historyId": 9877,
            "leadId": 12345,
            "type": "",
            "category": "",
            "text": "Rückruf vereinbart",
            "reminderDate": "2026-05-25 00:00:00",
            "assignedTo": 12,
            "priority": 2,
            "completed": false,
            "createdBy": 12,
            "created": "2026-05-18 14:35:00",
            "deleted": false
        },
        {
            "historyId": 9876,
            "leadId": 12345,
            "type": "",
            "category": "Telefon",
            "text": "Telefonat geführt — Patient ist interessiert.",
            "completed": false,
            "createdBy": 12,
            "created": "2026-05-18 14:32:00",
            "deleted": false
        },
        {
            "historyId": 9870,
            "leadId": 12345,
            "type": "S",
            "category": "",
            "text": "Folder: Open → In discussion",
            "createdBy": 12,
            "created": "2026-05-14 10:02:00",
            "deleted": false
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3,
        "hasMore": false
    }
}