Datenmodell

Kontakte

Eine Person, mit der du in Kontakt bleibst. Trägt Identität (Name, Spitzname, E-Mail, Telefon), Kontext (Firma, Adresse, Social-Links) und Lifecycle-Felder (Geburtstag, Jahrestag, letzter Kontakt). Übergeordnetes Objekt für Notizen, Aktivitäten und Erinnerungen.

Modellname: contact
Endpunkte: 5
Max. Seitengröße: 200

Felder

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

FeldTypRegeln
citystring
max. Länge120
namestring
max. Länge200
tagstags-
colorstring
max. Länge24
emailstring
max. Länge320
notesstring
max. Länge8000
phonestring
max. Länge64
genderenum
enummale | female | other | unspecified
companystring
max. Länge200
countrystring
max. Länge120
twitterurl-
websiteurl-
birthdaystring
max. Länge32
favoritebool-
linkedinurl-
nicknamestring
max. Länge120
pronounsstring
max. Länge32
allergiesstring
max. Länge600
job_titlestring
max. Länge200
food_prefsstring
max. Länge600
how_we_metstring
max. Länge1000
anniversarystring
max. Länge32
address_linestring
max. Länge200
avatar_blob_idstring
max. Länge64
secondary_emailstring
max. Länge320
secondary_phonestring
max. Länge64
last_contacted_atstring
max. Länge32
stay_in_touch_topicstring
max. Länge400
stay_in_touch_frequencyenum
enumnever | weekly | biweekly | monthly | quarterly | yearly

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.
FeldAnlegbarÄnderbar
city
name
tags
color
email
notes
phone
gender
company
country
twitter
website
birthday
favorite
linkedin
nickname
pronouns
allergies
job_title
food_prefs
how_we_met
anniversary
address_line
avatar_blob_id
secondary_email
secondary_phone
last_contacted_at
stay_in_touch_topic
stay_in_touch_frequency

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

namedata__name
emaildata__email
companydata__company
citydata__city
countrydata__country
favoritedata__favorite
tagsdata__tags
genderdata__gender
stay_in_touch_frequencydata__stay_in_touch_frequency
statusstatus
is_archivedis_archived
owned_byowned_by

Sortier-Keys

created_atcreated_at
updated_atupdated_at
namedata__name
companydata__company
last_contacted_atdata__last_contacted_at
birthdaydata__birthday
stay_in_touch_frequencydata__stay_in_touch_frequency

Standard: name

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/contactcontact: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/contact?limit=20"
GET/xapi2/data/contact/{id}contact: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/contact/OBJECT_ID
POST/xapi2/data/contactcontact: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/contact \
     -d '{"name": "…"}'
PATCH/xapi2/data/contact/{id}contact: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/contact/OBJECT_ID \
     -d '{"name": "…"}'
DELETE/xapi2/data/contact/{id}contact: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/contact/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 contact list --limit 5
friendshipcli contact get <id>
friendshipcli contact create --name "Hello"
friendshipcli contact upsert --unique name --csv items.csv
friendshipcli contact schema   # Felder & Limits

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