Datenmodell

Eigene Felder

Beliebiges Label/Wert-Paar am Kontakt. kind steuert die Darstellung (Text / Zahl / Datum / URL / Boolean); auf der Leitung wird nur der textuelle value übertragen.

Modellname: custom_field

Endpunkte: 5

Max. Seitengröße: 200

Felder

Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.

Feld	Typ	Regeln
icon	`string`	max. Länge`32`
kind	`enum`	enum`text \| number \| date \| url \| bool`
label	`string`
value	`string`	max. Länge`2000`
parent_id	`string`	max. Länge`64`ref →`contact`owned

Mutabilität

Welche Felder darfst du senden, und wann? Felder ohne Markierung werden vom Server vergeben - das Senden ist kein Fehler, sie werden stillschweigend ignoriert.

Anlegbar - im POST-Body lesbar.Änderbar - im PATCH-Body lesbar.Server-verwaltet - vom Body ignoriert.

Feld	Typ	Anlegbar	Änderbar
icon	string
kind	enum
label	string
value	string
parent_id	string

Felder mit Anlegbar, aber ohne Änderbar, sind nach dem Erstellen unveränderlich. Server-verwaltete Felder umfassen id, Zeitstempel, Eigentümerschaft und Status.

Filter & Sortierung

Auf Listen-Endpunkten kombinierbar. Wiederholte Filter-Keys werden zu IN-Bedingungen, ein - vor einem Sort-Key kehrt die Richtung um. Beispiel: ?status=open&status=blocked&sort=-created_at.

Filter-Keys

parent_iddata__parent_id

kinddata__kind

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

labeldata__label

Standard: created_at

Endpunkte

Jeder Endpunkt unten zeigt seine HTTP-Methode, den Pfad und den dafür benötigten PAT-Scope. Code-Beispiele decken curl, JavaScript, TypeScript, Python, Rust, Java und WebSocket ab.

GET/xapi2/data/custom_fieldcustom_field:list

Objekte auflisten

Liefert eine paginierte Liste sichtbarer Objekte. Standard-Seitengröße 20; mit ?limit= änderbar (typabhängig begrenzt). ?after=<id> für Keyset-Paginierung bei nach created_at sortierten Listen, ?offset= für Offset-Paginierung.

curl -H "Authorization: Bearer pat_…" \
     "https://friendship-tracker.com/xapi2/data/custom_field?limit=20"

GET/xapi2/data/custom_field/{id}custom_field:read

Einzelnes Objekt lesen

Liefert das Objekt anhand der ID. 404, falls es nicht existiert oder du keinen Lese-Zugriff hast (beide Fälle sind bewusst zusammengelegt).

curl -H "Authorization: Bearer pat_…" \
     https://friendship-tracker.com/xapi2/data/custom_field/OBJECT_ID

POST/xapi2/data/custom_fieldcustom_field:create

Erstellen

Erstellt ein neues Objekt. Der Body ist ein flaches JSON-Dict mit Feldwerten. Server-seitige Felder (id, Zeitstempel, Ownership) werden automatisch gefüllt; nur die unten als anlegbar gelisteten Felder werden aus dem Body übernommen.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://friendship-tracker.com/xapi2/data/custom_field \
     -d '{"name": "…"}'

PATCH/xapi2/data/custom_field/{id}custom_field:update

Aktualisieren

Teilweise Aktualisierung. Nur Felder im Body werden verändert; alles andere bleibt erhalten. Gleiche Erlaubnisliste wie bei Create, abzüglich der nach dem Anlegen unveränderlichen Felder.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://friendship-tracker.com/xapi2/data/custom_field/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/custom_field/{id}custom_field:delete

Löschen

Entfernt das Objekt. Es verschwindet sofort aus allen Standard-Listen und wird von read / list nicht mehr zurückgegeben.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://friendship-tracker.com/xapi2/data/custom_field/OBJECT_ID

In der CLI

Dieselben Endpunkte sind auch über die Friendship Tracker CLI verfügbar. Für Skripte, CI und Bulk-Imports ist sie meist die schnellere Wahl.

friendshipcli custom_field list --limit 5
friendshipcli custom_field get <id>
friendshipcli custom_field create --parent-id "Hello"
friendshipcli custom_field upsert --unique parent_id --csv items.csv
friendshipcli custom_field schema   # Felder & Limits

Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli