Datenmodell

E-Mail-Postfach

Verbundenes Inbox-Konto (Google / Microsoft 365 / IMAP) für den Auto-Import von Bewerbungen per Mail.

Modellname: email_inbox

Endpunkte: 5

Max. Seitengröße: 10

Felder

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

Feld	Typ	Regeln
host	`string`
port	`number`	-
active	`bool`	-
provider	`string`	max. Länge`32`
username	`string`	max. Länge`200`
scan_folder	`string`	max. Länge`200`
connected_at	`string`	max. Länge`32`
last_scan_at	`string`	max. Länge`32`
scan_enabled	`bool`	-
total_errors	`number`	-
email_address	`string`	max. Länge`320`
last_scan_uid	`number`	-
total_ignored	`number`	-
total_scanned	`number`	-
total_imported	`number`	-
auto_match_jobs	`bool`	-
last_scan_error	`string`	max. Länge`400`
mail_account_id	`string`	max. Länge`64`ref →`mail_account`
filter_min_score	`number`	-
total_duplicates	`number`	-
auto_create_candidates	`bool`	-
filter_sender_allowlist	`list`	-
filter_sender_blocklist	`list`	-

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
host	string
port	number
active	bool
provider	string
username	string
scan_folder	string
connected_at	string
last_scan_at	string
scan_enabled	bool
total_errors	number
email_address	string
last_scan_uid	number
total_ignored	number
total_scanned	number
total_imported	number
auto_match_jobs	bool
last_scan_error	string
mail_account_id	string
filter_min_score	number
total_duplicates	number
auto_create_candidates	bool
filter_sender_allowlist	list
filter_sender_blocklist	list

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

mail_account_iddata__mail_account_id

activedata__active

scan_enableddata__scan_enabled

providerdata__provider

statusstatus

is_archivedis_archived

owned_by

created_bycreated_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

connected_atdata__connected_at

last_scan_atdata__last_scan_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/email_inboxemail_inbox: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://ki-bewerber-management.de/xapi2/data/email_inbox?limit=20"

GET/xapi2/data/email_inbox/{id}email_inbox: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://ki-bewerber-management.de/xapi2/data/email_inbox/OBJECT_ID

POST/xapi2/data/email_inboxemail_inbox: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://ki-bewerber-management.de/xapi2/data/email_inbox \
     -d '{"name": "…"}'

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

DELETE/xapi2/data/email_inbox/{id}email_inbox: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://ki-bewerber-management.de/xapi2/data/email_inbox/OBJECT_ID

In der CLI

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

atscli email_inbox list --limit 5
atscli email_inbox get <id>
atscli email_inbox create --mail-account-id "Hello"
atscli email_inbox upsert --unique mail_account_id --csv items.csv
atscli email_inbox schema   # Felder & Limits

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