Data model

Applications

Links a candidate to a job. Carries stage (new -> review -> screening -> interview -> offer -> hired | rejected | talent_pool), KI fit-score, source, cover-letter URL, resume URL, and intra-column kanban position.

Model name: application
Endpoints: 5
Max page size: 500

Fields

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

FieldTypeConstraints
tagstags-
stageenum
enumnew | review | screening | interview | offer | hired | rejected | talent_pool | withdrawn
cv_urlurl
max length2048
job_idstring
max length64ref →job
skillstags
max count100item max160
sourcestring
max length64
answersdict
max keys80
fit_gapslist-
positionnumber-
educationlist-
fit_flagstags-
fit_scorenumber-
source_idstring
max length64ref →source
video_urlurl
max length2048
applied_atstring
max length32
cv_blob_idstring
max length64
experiencelist-
source_uidnumber-
attachmentslist-
cv_feedbackenum
enumok | edited | incomplete
candidate_idstring
max length64ref →candidate
cover_letterstring
max length16000
source_labelstring
max length200
status_tokenstring
max length64
fit_breakdowndict-
fit_reasoningstring
max length4000
fit_strengthslist-
last_stage_atstring
max length32
rejected_notestring
max length2000
source_folderstring
max length200
stage_historylist-
previous_stagestring
max length32
source_subjectstring
max length500
fit_computed_atstring
max length32
rejected_reasonenum
enumnot_qualified | salary_mismatch | location_mismatch | culture_mismatch | withdrew | ghosted | filled_internally | duplicate | other
source_inbox_idstring
max length64
cover_letter_urlurl
max length2048
source_followupslist-
source_from_addrstring
max length320
source_from_namestring
max length200
source_account_idstring
max length64
source_message_idstring
max length400
source_match_scorenumber-
source_received_atstring
max length32
source_body_previewstring
max length2000
source_match_reasonstring
max length400
cover_letter_blob_idstring
max length64
last_inbound_email_atstring
max length32
fit_interview_questionslist-

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
tags
stage
cv_url
job_id
skills
source
answers
fit_gaps
position
education
fit_flags
fit_score
source_id
video_url
applied_at
cv_blob_id
experience
source_uid
attachments
cv_feedback
candidate_id
cover_letter
source_label
status_token
fit_breakdown
fit_reasoning
fit_strengths
last_stage_at
rejected_note
source_folder
stage_history
previous_stage
source_subject
fit_computed_at
rejected_reason
source_inbox_id
cover_letter_url
source_followups
source_from_addr
source_from_name
source_account_id
source_message_id
source_match_score
source_received_at
source_body_preview
source_match_reason
cover_letter_blob_id
last_inbound_email_at
fit_interview_questions
starred

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

job_iddata__job_id
candidate_iddata__candidate_id
stagedata__stage
source_iddata__source_id
rejected_reasondata__rejected_reason
is_archiveddata__is_archived
status
is_archivedis_archived
owned_byowned_by
created_bycreated_by

Sort keys

created_atcreated_at
updated_atupdated_at
applied_atdata__applied_at
fit_scoredata__fit_score
positiondata__position
last_stage_atdata__last_stage_at

Default: position

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/applicationapplication: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/application?limit=20"
GET/xapi2/data/application/{id}application: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/application/OBJECT_ID
POST/xapi2/data/applicationapplication: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/application \
     -d '{"name": "…"}'
PATCH/xapi2/data/application/{id}application:update

Update

Partial update. Only fields included in the body are touched; everything else is preserved. Same allow-list as create, minus the fields that are immutable post-create.

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

Delete

Removes the object. It vanishes from every default list immediately and stops being returned by read / list.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://ki-bewerber-management.de/xapi2/data/application/OBJECT_ID

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 application list --limit 5
atscli application get <id>
atscli application create --job-id "Hello"
atscli application upsert --unique job_id --csv items.csv
atscli application schema   # fields & limits

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