Data model

Inbox log

Every inbox scan that imported, skipped or failed to import an application.

Model name: email_import_log
Endpoints: 3
Max page size: 200

Fields

Per-field validation rules. Values that violate any constraint are rejected with 400 before they reach the database.

FieldTypeConstraints
scorenumber-
reason
max length1000
senderstring
max length320
statusenum
enumimported | duplicate | ignored | error
previewstring
max length2000
signalslist-
subjectstring
max length500
message_idstring
max length400
source_uidnumber-
attachmentslist-
match_scorenumber-
received_atstring
max length32
sender_namestring
max length200
sender_emailstring
max length320
error_messagestring
max length1000
source_folderstring
max length200
email_inbox_idstring
max length64
matched_job_idstring
max length64
matched_job_titlestring
max length200
matched_candidate_idstring
max length64
matched_application_idstring
max length64

Mutability

Which fields can you send, and when? Anything without a marker is server-managed - sending it isn't an error, it's silently ignored.

Create-only - read from POST body.Patchable - read from PATCH body.Server-managed - ignored on the body.
FieldCreatePatch
score
reason
sender
status
preview
signals
subject
message_id
source_uid
attachments
match_score
received_at
sender_name
sender_email
error_message
source_folder
email_inbox_id
matched_job_id
matched_job_title
matched_candidate_id
matched_application_id

Fields marked create-only but not patchable are immutable after creation. Server-managed fields include id, timestamps, ownership, and status.

Filtering & sorting

Combinable on list endpoints. Repeating a filter key produces an IN clause; prefixing a sort key with - reverses direction. Example: ?status=open&status=blocked&sort=-created_at.

Filter keys

statusdata__status
email_inbox_iddata__email_inbox_id
matched_job_iddata__matched_job_id
matched_candidate_iddata__matched_candidate_id
matched_application_iddata__matched_application_id
message_iddata__message_id
statusstatus
owned_byowned_by
created_bycreated_by

Sort keys

created_atcreated_at
received_atdata__received_at

Default: created_at

Endpoints

Each endpoint below lists its HTTP method, path, and the PAT scope it needs. Code samples cover curl, JavaScript, TypeScript, Python, Rust, Java, and WebSocket.

GET/xapi2/data/email_import_logemail_import_log:list

List objects

Returns a paginated list of objects you can read. Default page size is 20; pass ?limit= to change (capped per type). Use ?after=<id> for keyset pagination on created_at-sorted lists, or ?offset= for offset paging.

curl -H "Authorization: Bearer pat_…" \
     "https://ki-bewerber-management.de/xapi2/data/email_import_log?limit=20"
GET/xapi2/data/email_import_log/{id}email_import_log:read

Read one

Returns the object by id. 404 if it does not exist or you cannot read it (the two cases are intentionally conflated).

curl -H "Authorization: Bearer pat_…" \
     https://ki-bewerber-management.de/xapi2/data/email_import_log/OBJECT_ID
POST/xapi2/data/email_import_logemail_import_log:create

Create

Creates a new object. Body is a flat JSON dict of field values. Server-side fields (id, timestamps, ownership) are filled automatically; only fields listed below as creatable are read from the body.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://ki-bewerber-management.de/xapi2/data/email_import_log \
     -d '{"name": "…"}'

Use in CLI

The same endpoints are also exposed via the KI BMS CLI. For scripts, CI, and bulk imports it's usually the faster path.

atscli email_import_log list --limit 5
atscli email_import_log get <id>
atscli email_import_log create --email-inbox-id "Hello"
atscli email_import_log schema   # fields & limits

Full command reference, profiles, CSV import, auto-retry, NDJSON streaming → /docs/cli