Data model

Interviews

Scheduled meeting tied to an application. Carries kind (phone / video / onsite / take-home), time, duration, interviewers, meeting link / room, status, invite note.

Model name: interview

Endpoints: 5

Max page size: 200

Fields

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

Field	Type	Constraints
kind	`enum`
notes	`string`	max length`8000`
title	`string`	max length`200`
agenda	`string`	max length`4000`
job_id	`string`	max length`64`
status	`enum`	enum`scheduled \| completed \| no_show \| cancelled \| rescheduled`
location	`string`	max length`200`
meeting_url	`url`	max length`2048`
send_invite	`bool`	-
candidate_id	`string`	max length`64`
scheduled_at	`string`	max length`32`
application_id	`string`	max length`64`ref →`application`
interviewer_id	`string`	max length`64`
interviewer_ids	`list`	-
duration_minutes	`number`	-

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.

Field	Type	Create	Patch
kind	enum
notes	string
title	string
agenda	string
job_id	string
status	enum
location	string
meeting_url	url
send_invite	bool
candidate_id	string
scheduled_at	string
application_id	string
interviewer_id	string
interviewer_ids	list
duration_minutes	number

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

application_iddata__application_id

candidate_iddata__candidate_id

job_iddata__job_id

kinddata__kind

statusdata__status

interviewer_iddata__interviewer_id

status

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sort keys

scheduled_atdata__scheduled_at

created_atcreated_at

updated_atupdated_at

Default: scheduled_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/interviewinterview: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://www.ki-bewerber-management.de/xapi2/data/interview?limit=20"

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

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

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

DELETE/xapi2/data/interview/{id}interview: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://www.ki-bewerber-management.de/xapi2/data/interview/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 interview list --limit 5
atscli interview get <id>
atscli interview create --application-id "Hello"
atscli interview upsert --unique application_id --csv items.csv
atscli interview schema   # fields & limits

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