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

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

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

POST https://dev.vitabyte.ch/v1/sales/getLeads
Payload
{
    "filter": {
        "folderId": 3,
        "country": "CH"
    },
    "offset": 0,
    "limit": 100,
    "orderBy": "lastActivity",
    "orderDir": "desc"
}
Response