Kontakte - API-Referenz - PlanDocket Dokumentation

Endpunkte

GET


                    /api/v1/contacts

Alle Kontakte auflisten

GET


                    /api/v1/contacts/{id}

Einzelnen Kontakt abrufen

POST


                    /api/v1/contacts

Neuen Kontakt erstellen

PUT/PATCH


                    /api/v1/contacts/{id}

Kontakt aktualisieren

DELETE


                    /api/v1/contacts/{id}

Kontakt löschen

Abfrageparameter

Parameter	Beschreibung
`search`	Suchbegriff zum Filtern der Ergebnisse
`category_key`	Nach Kategorie-Schlüssel filtern
`event_key`	Nach Event-Schlüssel filtern
`sort`	Sortierfeld (company_name, last_name, first_name, email, customer_number, city, created_at)
`order`	Sortierrichtung (ASC oder DESC, Standard: DESC)
`include`	Verknüpfte Daten einschließen (categories, events)

Request-Schema

Parameter	Typ	Erforderlich	Beschreibung
`email`	string	Nein	E-Mail-Adresse
`company_name`	string	Nein	Firmenname
`first_name`	string	Nein	Vorname
`last_name`	string	Nein	Nachname
`phone`	string	Nein	Telefonnummer
`fax`	string	Nein	Faxnummer
`mobile`	string	Nein	Mobiltelefonnummer
`customer_number`	string	Nein	Kundennummer
`address`	string	Nein	Straßenadresse
`postal_code`	string	Nein	Postleitzahl
`city`	string	Nein	Stadt
`country`	string	Nein	Ländercode
`state`	string	Nein	Bundesland oder Region
`website`	string	Nein	Website-URL
`notes`	string	Nein	Interne Notizen
`tax_id`	string	Nein	Steuer-Identifikationsnummer
`rating`	integer	Nein	Kontaktbewertung (1-5, Standard: 3)
`account_access_enabled`	boolean	Nein	Ob der Kontakt Zugang zum Benutzerportal hat
`category_keys`	array	Nein	Array von Kategorie-Schlüsseln zur Zuweisung
`event_keys`	array	Nein	Array von Event-Schlüsseln zur Verknüpfung als Teilnehmer

Response-Schema

Feld	Typ
`id`	integer
`customer_number`	string\|null
`company_name`	string\|null
`first_name`	string\|null
`last_name`	string\|null
`address`	string\|null
`postal_code`	string\|null
`city`	string\|null
`country`	string\|null
`state`	string\|null
`phone`	string\|null
`fax`	string\|null
`mobile`	string\|null
`email`	string\|null
`website`	string\|null
`notes`	string\|null
`tax_id`	string\|null
`rating`	integer
`account_access_enabled`	boolean
`has_account`	boolean
`created_at`	string
`updated_at`	string

Codebeispiele

curl -X GET "https://your-tenant.plandocket.com/api/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://your-tenant.plandocket.com';

$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => $baseUrl . '/api/v1/contacts',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json',
    ],
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);

const apiKey = 'YOUR_API_KEY';
const baseUrl = 'https://your-tenant.plandocket.com';

const response = await fetch(`${baseUrl}/api/v1/contacts`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

import requests

api_key = 'YOUR_API_KEY'
base_url = 'https://your-tenant.plandocket.com'

headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json',
}

response = requests.get(f'{base_url}/api/v1/contacts', headers=headers)
data = response.json()
print(data)

Beispiel-Antwort

200 OK

{
  "data": {
    "contact_id": 1,
    "created_at": 1704067200,
    "updated_at": 1704067200
  },
  "meta": {
    "request_id": "req_abc123"
  }
}