Endpoints / getLead

getLead

Einzelnen Lead abrufen

Identifizierbar via leadId ODER uniqid. uniqid bevorzugen für Integrationen (stabile externe ID).

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Eines von beidem ist Pflicht: leadId (int) oder uniqid (mindestens 8 Zeichen). Für Integrationen ist die uniqid die stabilere Wahl.

Parameter	Pflicht	Typ	Beispiel / Default
`leadId` Alternativ zu uniqid	optional	integer
`uniqid` Alternativ zu leadId. Bevorzugt für externe Systeme.	optional	string

Response Parameters

Die Feldstruktur folgt denselben Blöcken wie createLead und modifyLead; das Sparse-Fieldset von getLeads adressiert genau diese Blöcke. Fehler: HTTP 400 Provide a valid leadId or uniqid., HTTP 404 Lead not found. (auch bei soft-deleted Leads).

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/getLead

Payload

{
    "leadId": 12345
}

Response

{
    "status": true,
    "msg": "Success",
    "result": {
        "leadId": 12345,
        "uniqid": "5f2b9c41a7e34",
        "ispatient": 1,
        "contact": {
            "title": "Herr",
            "salutation": "Herr",
            "firstname": "Max",
            "lastname": "Mustermann",
            "gender": "M",
            "dob": "1980-02-21",
            "nationality": "CH"
        },
        "address": {
            "street": "Musterstrasse 1",
            "zip": "8000",
            "city": "Zürich",
            "country": "Schweiz",
            "countryCode": "CH"
        },
        "communication": {
            "mail": "max@example.com",
            "phone": "+41 44 000 00 00",
            "mobile": "+41 79 000 00 00"
        },
        "insurance": {
            "kvg": "Helsana",
            "payerType": "insurance"
        },
        "folder": {
            "folderId": 3,
            "name": "In discussion",
            "kat": "P"
        },
        "assignee": 12,
        "flags": [
            "VIP"
        ],
        "what": "Knie-Schmerzen",
        "nextStep": "Telefonat vereinbart",
        "patid": null,
        "created": "2026-05-12 09:14:00",
        "lastActivity": "2026-05-18 14:32:00",
        "deleted": false
    }
}