Data model

Jobs

An open role. Carries title, department, location, employment type, KI fit-profile (requirements + knockout criteria), status, and a public careers-page slug. Parent for applications.

Model name: job

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
slug	`string`
tags	`tags`	-
color	`string`	max length`24`
intro	`string`	max length`8000`
title	`string`	max length`200`
public	`bool`	-
remote	`enum`	enum`onsite \| hybrid \| remote`
skills	`tags`	-
status	`enum`	enum`draft \| open \| paused \| closed \| filled`
country	`string`	max length`80`
summary	`string`	max length`600`
benefits	`string`	max length`4000`
currency	`string`	max length`8`
language	`string`	max length`16`
location	`string`	max length`120`
team_ids	`list`	-
closed_at	`string`	max length`32`
headcount	`number`	-
opened_at	`string`	max length`32`
seniority	`enum`	enum`junior \| mid \| senior \| lead \| principal`
department	`string`	max length`120`
promotions	`list`	-
salary_max	`number`	-
salary_min	`number`	-
ai_criteria	`list`	-
description	`string`	max length`16000`
hiring_team	`list`	-
pipeline_id	`string`	max length`64`
address_form	`enum`	enum`du \| sie`
career_level	`enum`	enum`helper \| entry \| experienced \| team_lead \| executive`
job_category	`string`	max length`64`
nice_to_have	`string`	max length`4000`
requirements	`string`	max length`8000`
video_prompt	`string`	max length`2000`
closing_words	`string`	max length`4000`
salary_period	`enum`	enum`year \| month \| week \| day \| hour`
boards_enabled	`list`	-
work_locations	`list`	-
auto_promote_at	`number`	-
employment_type	`enum`	enum`full_time \| part_time \| internship \| working_student \| freelance \| contract \| dual_study \| trainee \| side_job`
job_subcategory	`string`	max length`64`
ai_screen_prompt	`string`	max length`4000`
responsibilities	`string`	max length`8000`
scoring_criteria	`list`	-
work_arrangement	`enum`	enum`onsite \| hybrid \| remote \| office`
ai_screen_enabled	`bool`	-
auto_reject_below	`number`	-
hiring_manager_id	`string`	max length`64`
salary_visibility	`enum`	enum`public \| team \| private`
target_close_date	`string`	max length`32`
video_max_minutes	`number`	-
external_apply_url	`url`	max length`2048`
knockout_questions	`list`	-
screening_questions	`list`	-
application_language	`string`	max length`16`
application_documents	`dict`	-
auto_send_confirmation	`bool`	-
auto_thresholds_enabled	`bool`	-

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
slug	string
tags	tags
color	string
intro	string
title	string
public	bool
remote	enum
skills	tags
status	enum
country	string
summary	string
benefits	string
currency	string
language	string
location	string
team_ids	list
closed_at	string
headcount	number
opened_at	string
seniority	enum
department	string
promotions	list
salary_max	number
salary_min	number
ai_criteria	list
description	string
hiring_team	list
pipeline_id	string
address_form	enum
career_level	enum
job_category	string
nice_to_have	string
requirements	string
video_prompt	string
closing_words	string
salary_period	enum
boards_enabled	list
work_locations	list
auto_promote_at	number
employment_type	enum
job_subcategory	string
ai_screen_prompt	string
responsibilities	string
scoring_criteria	list
work_arrangement	enum
ai_screen_enabled	bool
auto_reject_below	number
hiring_manager_id	string
salary_visibility	enum
target_close_date	string
video_max_minutes	number
external_apply_url	url
knockout_questions	list
screening_questions	list
application_language	string
application_documents	dict
auto_send_confirmation	bool
auto_thresholds_enabled	bool
ai_thresholds	-

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

titledata__title

departmentdata__department

locationdata__location

employment_typedata__employment_type

senioritydata__seniority

remotedata__remote

status

publicdata__public

hiring_manager_iddata__hiring_manager_id

tagsdata__tags

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sort keys

created_atcreated_at

updated_atupdated_at

titledata__title

opened_atdata__opened_at

target_close_datedata__target_close_date

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/jobjob: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/job?limit=20"

GET/xapi2/data/job/{id}job: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/job/OBJECT_ID

POST/xapi2/data/jobjob: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/job \
     -d '{"name": "…"}'

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

DELETE/xapi2/data/job/{id}job: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/job/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 job list --limit 5
atscli job get <id>
atscli job create --title "Hello"
atscli job upsert --unique title --csv items.csv
atscli job schema   # fields & limits

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