Data model

Company profile

Branding, privacy and careers-page settings for this app - exactly one row per app.

Model name: company_profile

Endpoints: 5

Max page size: 5

Fields

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

Field	Type	Constraints
name	`string`	max length`200`
size	`enum`	enum`1-10 \| 11-50 \| 51-200 \| 201-500 \| 500+`
summary	`string`	max length`4000`
website	`url`	max length`2048`
industry	`string`	max length`200`
logo_url	`string`	max length`1500000`
banner_url	`string`	max length`2500000`
show_about	`bool`	-
imprint_url	`url`	max length`2048`
privacy_url	`url`	max length`2048`
accent_color	`string`	max length`16`
display_name	`string`	max length`200`
main_location	`string`	max length`200`
retention_unit	`enum`	enum`weeks \| months \| years`
retention_value	`number`	-
show_other_jobs	`bool`	-
public_careers_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
name	string
size	enum
summary	string
website	url
industry	string
logo_url	string
banner_url	string
show_about	bool
imprint_url	url
privacy_url	url
accent_color	string
display_name	string
main_location	string
retention_unit	enum
retention_value	number
show_other_jobs	bool
public_careers_enabled	bool

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

statusstatus

is_archivedis_archived

owned_byowned_by

created_bycreated_by

Sort keys

created_atcreated_at

updated_atupdated_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/company_profilecompany_profile: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/company_profile?limit=20"

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

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

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

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

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