Datenmodell

Pilot-Leads

Pilot- / Partner- / LOI-Kontakt aus dem Partner-Kanban. An einen Antrag gebunden; Zustand lead → Gespräch → LOI-Entwurf → LOI unterschrieben → verloren.

Modellname: lead

Endpunkte: 5

Max. Seitengröße: 500

Felder

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

Feld	Typ	Regeln
org	`string`
size	`string`	max. Länge`100`
notes	`string`	max. Länge`2000`
state	`enum`	enum`lead \| talking \| loi_draft \| loi_signed \| lost`
region	`string`	max. Länge`100`
contact	`string`	max. Länge`200`
grant_id	`string`	max. Länge`64`ref →`grant`
loi_signed_at	`string`	max. Länge`32`

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
org	string
size	string
notes	string
state	enum
region	string
contact	string
grant_id	string
loi_signed_at	string
first_name	-
last_name	-
gender	-
company	-
position	-
fair_location	-
phone	-
email	-
linkedin	-
website	-
city	-
country	-
lead_status	-
note	-
tags	-
inferred_gender	-
inferred_country	-
inferred_domain	-
account_id	-
lead_source_id	-
last_contacted_at	-

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

first_namedata__first_name

last_namedata__last_name

companydata__company

emaildata__email

phonedata__phone

citydata__city

countrydata__country

lead_statusdata__lead_status

tagsdata__tags

genderdata__gender

inferred_countrydata__inferred_country

inferred_genderdata__inferred_gender

inferred_domaindata__inferred_domain

account_iddata__account_id

lead_source_iddata__lead_source_id

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

first_namedata__first_name

last_namedata__last_name

companydata__company

lead_statusdata__lead_status

last_contacted_atdata__last_contacted_at

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/leadlead: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://granttool.de/xapi2/data/lead?limit=20"

GET/xapi2/data/lead/{id}lead: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://granttool.de/xapi2/data/lead/OBJECT_ID

POST/xapi2/data/leadlead: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://granttool.de/xapi2/data/lead \
     -d '{"name": "…"}'

PATCH/xapi2/data/lead/{id}lead: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://granttool.de/xapi2/data/lead/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/lead/{id}lead: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://granttool.de/xapi2/data/lead/OBJECT_ID

In der CLI

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

grantscli lead list --limit 5
grantscli lead get <id>
grantscli lead create --first-name "Hello"
grantscli lead upsert --unique first_name --csv items.csv
grantscli lead schema   # Felder & Limits

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