Endpoints / getLeads

getLeads

Liste der Leads mit Filter, Sortierung und Pagination

Ersetzt den klassischen Excel-Export 'explorer'. Filter erlauben Filterung nach Folder, Source, Country, Flags, Datumsbereich, Suche und Soft-Deleted-Flag.

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Filter-Schlüssel: ispatient (0/1), folderId (int oder int-Array), assignee, watcherId, source, country (ISO-2), flags (String-Array), search, createdFrom/createdTo, lastActivityFrom/lastActivityTo (YYYY-MM-DD) und includeDeleted.
orderBy-Whitelist: leadId, lastActivity, created, folder, priority, lastname. limit maximal 1000.

Parameter	Pflicht	Typ	Beispiel / Default
`filter` Filter-Object (folderId, source, country, flags, search, createdFrom, createdTo, includeDeleted)	optional	object
`offset`	optional	integer	default: `0`
`limit`	optional	integer	default: `100`
`orderBy`	optional	string enum: leadId \| lastActivity \| created \| folder \| priority \| lastname	default: `lastActivity`
`orderDir`	optional	string enum: asc \| desc	default: `desc`
`fields` Sparse fieldset — nur diese Top-Level-Felder zurückgeben	optional	array

Response Parameters

Keine Fehlerfälle — eine leere Liste ist ein gültiges Ergebnis (result: []).

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

Payload

{
    "filter": {
        "ispatient": 1,
        "folderId": [
            1,
            2,
            3
        ],
        "search": "",
        "createdFrom": "2026-01-01",
        "includeDeleted": false
    },
    "offset": 0,
    "limit": 100,
    "orderBy": "lastActivity",
    "orderDir": "desc",
    "fields": [
        "leadId",
        "contact",
        "folder",
        "assignee",
        "lifecycle"
    ]
}

Response

{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "leadId": 12345,
            "uniqid": "5f2b9c41a7e34",
            "contact": {
                "firstname": "Max",
                "lastname": "Mustermann",
                "dob": "1980-02-21"
            },
            "folder": {
                "folderId": 3,
                "name": "In discussion",
                "kat": "P"
            },
            "assignee": 12,
            "lifecycle": {
                "created": "2026-05-12 09:14:00",
                "lastActivity": "2026-05-18 14:32:00",
                "deleted": false
            }
        },
        {
            "leadId": 12344,
            "uniqid": "5f2b7ae03c118",
            "contact": {
                "firstname": "Anna",
                "lastname": "Beispiel",
                "dob": "1985-04-12"
            },
            "folder": {
                "folderId": 1,
                "name": "Open",
                "kat": "P"
            },
            "assignee": 0,
            "lifecycle": {
                "created": "2026-05-11 16:40:00",
                "lastActivity": "2026-05-17 11:20:00",
                "deleted": false
            }
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 2,
        "hasMore": false
    }
}