Klantly Developers

API-referentie

Gebruikers

De gebruikers van je bedrijf, bijvoorbeeld om een deal aan iemand toe te wijzen.

Endpoints

Gebruikers opvragen

GET /api/v1/users

De gebruikers van je bedrijf, op volgorde van id. De id gebruik je als assigned_user_id van een deal.

Scope
users.read — Gebruikers van het bedrijf lezen

Queryparameters

NaamTypeOmschrijving
limit integer Aantal resultaten per pagina. van 1 tot 100 · standaard: 50
cursor string De next_cursor of prev_cursor uit meta van het vorige antwoord.
filter[status] string Alleen actieve of alleen gedeactiveerde gebruikers. een van: active, inactive

Voorbeeldverzoek

cURL
curl "https://app.klantly.com/api/v1/users" \
  -H "Authorization: Bearer $KLANTLY_API_KEY"
PHP
$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'];
JavaScript
const response = await fetch('https://app.klantly.com/api/v1/users', {
  headers: {
    Authorization: `Bearer ${process.env.KLANTLY_API_KEY}`,
  },
});

const { data } = await response.json();
Python
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"]

Antwoord 200

Het antwoord is een lijst met cursorpaginering: data bevat de objecten, meta de paginering.

Voorbeeldantwoord
{
  "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
  }
}

Mogelijke fouten

Daarnaast kan elk endpoint de algemene fouten geven, zoals een ongeldige sleutel of een bereikte limiet. Bekijk alle foutcodes.

Het object

Alle velden zijn altijd aanwezig; een veld zonder waarde is null.

VeldTypeOmschrijving
object string Altijd "user".
id string Id van de gebruiker.
name string Naam.
email string (email) E-mailadres.
role string Naam van de rol in je bedrijf, of null zonder rol. kan leeg zijn (null)
is_owner boolean De eigenaar van het account.
status string active of inactive (gedeactiveerd). een van: active, inactive
created_at string (date-time) Aangemaakt op (UTC).