API-Referenz
Benutzer
Die Benutzer Ihres Unternehmens, zum Beispiel um einen Deal jemandem zuzuweisen.
Endpunkte
Benutzer auflisten
GET
/api/v1/users
Die Benutzer Ihres Unternehmens, nach ID sortiert. Verwenden Sie die ID als assigned_user_id eines Deals.
- Scope
-
users.read— Benutzer des Unternehmens lesen
Query-Parameter
| Name | Typ | Beschreibung |
|---|---|---|
limit |
integer | Anzahl der Ergebnisse pro Seite. von 1 bis 100 · Standard: 50 |
cursor |
string | Der next_cursor oder prev_cursor aus meta der vorherigen Antwort. |
filter[status] |
string | Nur aktive oder nur deaktivierte Benutzer. einer von: active, inactive |
Beispielanfrage
curl "https://app.klantly.com/api/v1/users" \
-H "Authorization: Bearer $KLANTLY_API_KEY"$client = new \GuzzleHttp\Client([
'base_uri' => 'https://app.klantly.com/api/v1/',
'headers' => ['Authorization' => 'Bearer ' . getenv('KLANTLY_API_KEY')],
]);
$response = $client->request('GET', 'users');
$data = json_decode((string) $response->getBody(), true)['data'];const response = await fetch('https://app.klantly.com/api/v1/users', {
headers: {
Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
},
});
const { data } = await response.json();import os
import requests
response = requests.get(
"https://app.klantly.com/api/v1/users",
headers={
"Authorization": f"Bearer {os.environ['KLANTLY_API_KEY']}",
},
)
data = response.json()["data"]Antwort 200
Die Antwort ist eine Liste mit Cursor-Paginierung: data enthält die Objekte, meta die Paginierung.
{
"data": [
{
"object": "user",
"id": "7",
"name": "Sanne Bakker",
"email": "sanne@devriesbouw.nl",
"role": "Verkoop",
"is_owner": false,
"status": "active",
"created_at": "2026-09-14T10:15:00Z"
}
],
"meta": {
"limit": 50,
"next_cursor": "eyJpZCI6IjlkM2Y2YzFlIn0",
"prev_cursor": null
}
}Mögliche Fehler
-
403
insufficient_scope— Dieser API-Schlüssel hat keinen Zugriff auf diese Aktion. -
422
validation_failed— Die Eingabe ist ungültig.
Das Objekt
Alle Felder sind immer vorhanden; ein Feld ohne Wert ist null.
| Feld | Typ | Beschreibung |
|---|---|---|
object |
string | Immer „user“. |
id |
string | ID des Benutzers. |
name |
string | Name. |
email |
string (email) | E-Mail-Adresse. |
role |
string | Name der Rolle in Ihrem Unternehmen, oder null ohne Rolle. kann leer sein (null) |
is_owner |
boolean | Der Inhaber des Kontos. |
status |
string | active oder inactive (deaktiviert). einer von: active, inactive |
created_at |
string (date-time) | Erstellt am (UTC). |