Kunden
Kundenkonten für externe Mitarbeiter verwalten.
Kunden repräsentieren externe Mitarbeiter, die mit eingeschränkten Berechtigungen auf bestimmte Boards zugreifen können. Sie können ihnen zugewiesene Tickets ansehen und damit interagieren.
Kunden auflisten
GET /api/v1/customersQuery-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| page | number | Nein | Seitennummer (Standard: 1) |
| limit | number | Nein | Einträge pro Seite (Standard: 20) |
| search | string | Nein | Nach Name oder E-Mail suchen |
Beispiel-Response
{
"data": [
{
"id": "cst_abc123",
"name": "Client Corp",
"email": "[email protected]",
"phone": "+1-555-0123",
"isArchived": false,
"createdAt": "2025-01-15T10:00:00Z"
}
],
"total": 8,
"page": 1,
"pageSize": 20,
"totalPages": 1
}Kunde erstellen
POST /api/v1/customersBerechtigung erforderlich: members:edit
Request Body
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| name | string | Ja | Kundenname (max. 200 Zeichen) |
| string | Nein | Kunden-E-Mail | |
| phone | string | Nein | Kundentelefon (max. 50 Zeichen) |
Beispiel-Request
{
"name": "Client Corp",
"email": "[email protected]",
"phone": "+1-555-0123"
}Kunde abrufen
GET /api/v1/customers/{customerId}Gibt Details zu einem bestimmten Kunden zurück.
Kunde aktualisieren
PATCH /api/v1/customers/{customerId}Berechtigung erforderlich: members:edit
Request Body
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| name | string | Nein | Kundenname |
| string | Nein | Kunden-E-Mail | |
| phone | string | Nein | Kundentelefon |
Kunde archivieren
POST /api/v1/customers/{customerId}/archiveBerechtigung erforderlich: members:edit
Archiviert den Kunden und blendet ihn aus aktiven Listen aus, ohne Daten zu löschen.
Kunde löschen
DELETE /api/v1/customers/{customerId}Berechtigung erforderlich: members:edit
Löscht den Kunden dauerhaft. Gibt 204 No Content zurück.