Endpoints / getFolders

getFolders

Pipeline-Folders auflisten

Inklusive Lead-Counts pro Folder wenn includeCounts=true. forUserId>0 liefert unread-Counts für diesen User.

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`kat` P=Patient, K=Kontakt, null=beide	optional	string enum: P \| K
`includeCounts`	optional	boolean	default: `false`
`forUserId`	optional	integer	default: `0`

Response Parameters

Fehler: HTTP 400 kat must be P, K or omitted. Die Zähler erscheinen nur bei includeCounts: true; unreadCount bezieht sich auf forUserId, sofern gesetzt.

Field	Typ	Beschreibung
`folderId`	integer	Folder-ID
`name`	string	Bezeichnung des Folders
`kat`	string	`P` (Patient) oder `K` (Kontakt)
`count`	integer	Anzahl Leads im Folder
`unreadCount`	integer	Davon ungelesen für den angefragten User

Demo

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

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

Payload

{
    "kat": "P",
    "includeCounts": true,
    "forUserId": 12
}

Response

{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "folderId": 1,
            "name": "Open",
            "kat": "P",
            "count": 42,
            "unreadCount": 5
        },
        {
            "folderId": 2,
            "name": "To be contacted",
            "kat": "P",
            "count": 18,
            "unreadCount": 2
        },
        {
            "folderId": 3,
            "name": "In discussion",
            "kat": "P",
            "count": 9,
            "unreadCount": 0
        }
    ]
}