Endpoints / getCustomerByMail

getCustomerByMail

Patient anhand E-Mail-Adresse suchen

Erste Treffer-Match auf tblPatienten.mail. Für Webform-Integrationen (Existenz-Check vor Lead-Creation).

HTTP Request

POST https://dev.vitabyte.ch/v1/system/getCustomerByMail

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`mail` Exact-Match, keine Teilstring-Suche. Muss länger als 7 Zeichen sein und ein @ enthalten. Für unscharfe Suche searchPatients verwenden.	required	string	patient@example.com

Response Parameters

⚠ Envelope-Sonderfall: status ist der String "ok". result ist ein Array mit 0..N Treffern (Felder wie getCustomerById), msg zählt mit: No matches / 1 match / 3 matches. Ungültige Adresse: { "status": false, "msg": "Please provide a valid mail address" }, HTTP 200.

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

Parameter und Beispiele stammen aus der internen API-Collection; die OpenAPI-Spec weicht für diesen Endpoint davon ab.

POST https://dev.vitabyte.ch/v1/system/getCustomerByMail

Payload

{
    "mail": "max@example.com"
}

Response

{
    "status": "ok",
    "msg": "1 match",
    "result": [
        {
            "patid": 789,
            "lastname": "Mustermann",
            "firstname": "Max",
            "gender": "male",
            "dob": "1980-02-21",
            "title": "Herr",
            "street": "Musterstrasse 1",
            "zip": "8000",
            "city": "Zürich",
            "country": "Schweiz",
            "countrycode": "CH",
            "mobile": "+41 79 000 00 00",
            "mail": "max@example.com",
            "AHV": "756.0000.0000.00",
            "language": "de",
            "deleted": "0"
        }
    ]
}