Playground

Token eintragen, Endpoint wählen, Live-Request gegen die REST API v3 absetzen.

Live-API

Verbindung

Base-URL und Bearer-Token aus deinem i-Planner-Konto.

Base-URL

Produktion — api.i-planner.app

Token

Wird nicht gespeichert — geht direkt vom Browser an die API.

Request

Endpoint wählen, Path-Parameter füllen. Schreibende Calls (POST, PATCH, DELETE) verändern echte Daten.

Endpoint

Kunden abfragen

Scope

Erforderlicher Token-Scope

v3:customers:readDoku ↗

Query-Parameter

Nur aktivierte Parameter landen in der URL. Die Standardwerte entsprechen denen des Servers.

page

number · Standard 1

limit

number · Standard 10

with_addresses

boolean · Standard false

with_contacts

boolean · Standard false

with_jobs

boolean · Standard false

with_banks

boolean · Standard false

with_numbers

boolean · Standard false

with_identifications

boolean · Standard false

with_schema

boolean · Standard false

flat

boolean · Standard false

Code

cURL, Node.js, Python und PHP — live aus Endpoint, Parametern und Body. Der Token kommt aus IPLANNER_API_TOKEN.

bash

curl -X GET 'https://www.api.i-planner.app/v3/customers?page=1&limit=10&with_addresses=false&with_contacts=false&with_jobs=false&with_banks=false&with_numbers=false&with_identifications=false&with_schema=false&flat=false' \
  -H "Authorization: Bearer $IPLANNER_API_TOKEN"

const res = await fetch('https://www.api.i-planner.app/v3/customers?page=1&limit=10&with_addresses=false&with_contacts=false&with_jobs=false&with_banks=false&with_numbers=false&with_identifications=false&with_schema=false&flat=false', {
  headers: {
    Authorization: `Bearer ${process.env.IPLANNER_API_TOKEN}`,
  },
})
const data = await res.json()

import os, requests

res = requests.get(
    'https://www.api.i-planner.app/v3/customers',
    params={
        'page': 1,
        'limit': 10,
        'with_addresses': 'false',
        'with_contacts': 'false',
        'with_jobs': 'false',
        'with_banks': 'false',
        'with_numbers': 'false',
        'with_identifications': 'false',
        'with_schema': 'false',
        'flat': 'false',
    },
    headers={'Authorization': f'Bearer {os.environ["IPLANNER_API_TOKEN"]}'},
)
data = res.json()

<?php
$query = http_build_query([
  'page' => 1,
  'limit' => 10,
  'with_addresses' => 'false',
  'with_contacts' => 'false',
  'with_jobs' => 'false',
  'with_banks' => 'false',
  'with_numbers' => 'false',
  'with_identifications' => 'false',
  'with_schema' => 'false',
  'flat' => 'false',
]);
$ch = curl_init("https://www.api.i-planner.app/v3/customers?$query");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('IPLANNER_API_TOKEN')],
]);
$data = json_decode(curl_exec($ch), true);