Data model

Offers

Offer letter tied to an application. Carries gross salary, bonus, start date, term, status (draft / sent / accepted / declined / withdrawn).

Model name: offer

Endpoints: 5

Max page size: 100

Fields

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

Field	Type	Constraints
term	`enum`
bonus	`number`	-
job_id	`string`	max length`64`
status	`enum`	enum`draft \| sent \| accepted \| declined \| withdrawn \| expired`
sent_at	`string`	max length`32`
currency	`string`	max length`8`
bonus_note	`string`	max length`600`
decided_at	`string`	max length`32`
expires_at	`string`	max length`32`
start_date	`string`	max length`32`
term_until	`string`	max length`32`
letter_body	`string`	max length`16000`
candidate_id	`string`	max length`64`
salary_gross	`number`	-
weekly_hours	`number`	-
remote_policy	`string`	max length`200`
salary_period	`enum`	enum`yearly \| monthly \| daily \| hourly`
vacation_days	`number`	-
application_id	`string`	max length`64`ref →`application`
decline_reason	`string`	max length`600`
letter_blob_id	`string`	max length`64`

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
term	enum
bonus	number
job_id	string
status	enum
sent_at	string
currency	string
bonus_note	string
decided_at	string
expires_at	string
start_date	string
term_until	string
letter_body	string
candidate_id	string
salary_gross	number
weekly_hours	number
remote_policy	string
salary_period	enum
vacation_days	number
application_id	string
decline_reason	string
letter_blob_id	string

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

statusdata__status

currencydata__currency

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sort keys

created_atcreated_at

start_datedata__start_date

sent_atdata__sent_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/offeroffer: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/offer?limit=20"

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

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

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

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

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