{ "openapi": "3.2.0", "info": { "title": "Firmenakte API v2", "description": "v2 is the current API. Every call requires an API key in x-api-key; dashboard calls may use a session. Public data is identical for every customer; account data lives under /me. Exports freeze selections as jobs and retain files for 24 hours. v1 is legacy: supported for at least 12 months from 2026-10-04; any shutdown is announced 12 months ahead. New integrations should use v2.\n\n# Getting started\n\n- **API key:** Create a key at [firmenakte.at/app/api](https://firmenakte.at/app/api).\n- **Install:** `npm i @firmenakte/api-client`, then import `@firmenakte/api-client/v2`.\n- **API reference:** [v2](https://docs.firmenakte.at/openapi-v2.json) is the current API. [v1](https://docs.firmenakte.at/openapi.json) is legacy and remains supported for at least 12 months from 2026-10-04; any shutdown is announced 12 months ahead. New integrations should use v2. The package's root export remains v1.\n- **MCP:** Connect to `https://mcp.firmenakte.at/mcp`, the backend's MCP server for the v2 API. Sign in with your Firmenakte account through OAuth, without an API key. Write tools return a `confirmUrl`; open it to review and approve the action in the dashboard. See [MCP configuration](https://docs.firmenakte.at/MCP-CONFIG.md).\n\n## Quickstart\n\nOne request, one minute. `56247t` is Red Bull GmbH. An FNR alias resolves to the company's canonical Firmenakte-ID without a redirect.\n\n```sh\nexport FIRMENAKTE_KEY=\ncurl -H \"x-api-key: $FIRMENAKTE_KEY\" https://api.firmenakte.at/api/v2/companies/fnr:56247t\n```\n\n```ts\nimport { createApiClient, isApiError } from \"@firmenakte/api-client/v2\";\n\nconst client = createApiClient({ apiKey: process.env.FIRMENAKTE_KEY });\nconst { data: company } = await client.getCompany({ path: { id: \"fnr:56247t\" } });\nconsole.log(company.id, company.name);\n\ntry {\n await client.getCompany({ path: { id: \"fnr:999999x\" } });\n} catch (error) {\n if (isApiError(error) && error.status === 404) console.log(error.problem?.detail);\n else throw error;\n}\n```\n\nThe client has one method per operation, named by its `operationId` in the [v2 reference](https://docs.firmenakte.at/openapi-v2.json). Each takes `{ path, query, body, headers }` as the operation defines them; path parameters are encoded for you. A call resolves with `{ data, response }` for a 2xx answer and rejects with an `ApiError` carrying `status` and the problem JSON otherwise. Binary downloads take `parseAs: \"blob\"` or `\"stream\"`.\n\nDirect API calls need an API key (or a dashboard session). Public operations return the same register data to every customer. Your workspace's lists, fields and export jobs live under `/api/v2/me/…`; other workspaces' objects are not found.\n\n`GET /companies?q=red` finds companies. `POST /companies/search` accepts a nested filter tree. Global search returns register data only. `POST /me/search` accepts workspace fields and effective values when scoped to an explicit `listId`. Discover field paths and their capabilities through `GET /catalogs/fields` and workspace field keys through `GET /me/fields`.\n\n## IDs and register numbers\n\nFirmenakte-IDs are stable company (`C-`) and person (`P-`) identifiers with a check character. Use the returned ID for references. Register numbers such as `fnr:56247t`, `uid:ATU…` and `gisa:…` are aliases. Ambiguous aliases return `409` with candidates, malformed IDs `422`, missing objects `404`, erased objects `410`. People have no birth date, birth year or age in this API.\n\nA `documentKey` identifies a Firmenbuch document: download PDF or XML through `GET /documents/{key}/content`. A GISA number identifies a license: download its PDF through `GET /licenses/{gisaNumber}/extract`. These and export files are the named non-JSON exceptions; errors always remain problem JSON.\n\n## Paging and changes\n\nGlobal company, person and mixed searches return `{ items, nextCursor }`, with each item containing only `{ id, type, name, identifiers }`. Send `limit` (default 25, minimum 1, maximum 100) and the previous `nextCursor` as `cursor` until it is null. These searches have no total or count-only mode. Read additional fields through detail or batch endpoints.\n\nOther collections return `{ items, nextCursor, total? }`. Where supported, `limit=0` returns only `total`, with empty `items` and no `nextCursor`; a supplied cursor is still checked. Feeds require a positive limit. Cursors bind the filter and sort and expire after 24 hours; do not change the selection mid-traversal.\n\nChange feeds use a durable `after` sequence instead. Persist `nextCursor` even for an empty page. Delivery is at least once: deduplicate on event `id`. `GET /changes`, company/person `/changes`, and list `/me/lists/{id}/events` provide the corresponding feeds. Observation time and the register's publication date are separate.\n\n## Export jobs\n\n`POST /me/exports` takes `listId` or `query: { subject, where, filterVersion }`, optionally narrowed by `q`, and `format: csv | xlsx`. List exports use that list's columns; a query defaults to name, city, industry and registration date. Override with columnable catalog paths and `fields.`. `people: true` exports one row per person of a query with subject `person` (no `listId`).\n\nThe selection and values freeze at start (`asOf`). There is no row cap. The `202` response contains a job plus `Location` and `Retry-After`. Poll `GET /me/exports/{id}` until `succeeded` or `failed`, then download `GET /me/exports/{id}/file`. Files expire 24 hours after completion. The credit cost is `max(exportMinimum, ceil(rows / 1000) × exportRows)`, using `prices.exportMinimum` and `prices.exportRows` from `GET /me/credits`; an unmetered credential is not charged. A failed job is refunded. Polling and downloading do not incur another export charge.\n\n## Credits, cache and retries\n\nOperations declare `x-credits`; every response carries `Credits-Cost` and `Credits-Remaining`. A company detail costs 1 credit for an API key, including cache hits. Public GETs return ETags and `Cache-Control: private, no-cache`; `If-None-Match` with a matching ETag returns a free, bodyless `304`. Account reads use `private, no-store` and never ETags.\n\nSend an optional `Idempotency-Key` on writes and paid calls to replay the first response free for 24 hours. The same key with a different request is `409 idempotency_conflict`; use a new key when changing the request.\n\n## Errors\n\nAll errors are RFC 9457 `application/problem+json`: `type`, `title`, `status`, `detail`, stable `code`, `requestId` and validation `errors[]` with a parameter or JSON pointer. Quote the request ID when contacting support. No valid credential is `401`, exhausted credits `402`, throttling `429` with `Retry-After`. Follow `detail` to correct the request; see the linked error-code page for examples.\n\n## Reading numbers and compatible changes\n\nUnknown values are omitted, never invented zeros. Money is decimal with currency declared in the statement; dates are calendar dates and instants UTC. Compare financial figures only for the same filing year. v2 accepts only additive changes: ignore unknown response fields and enum values. Breaking changes require a new API version.\n", "version": "v2" }, "servers": [ { "url": "https://api.firmenakte.at" } ], "paths": { "/api/v2/me/selections": { "post": { "tags": [ "workspace.results" ], "summary": "Capture a fixed search selection", "description": "Freeze a complete ordered search selection on the server for a later confirmed save or export. Returns a handle and count, never all IDs. Maximum 100000 IDs, expires after 24 hours. Supply exactly one new companies, people or entries search without cursor. For a list defined by criteria, prefer creating the list with a query rule; capture is for an explicitly fixed snapshot. Ordinary pagination and aggregation do not need a capture. Costs one credit for keys; free for sessions. Responses are private, no-store.", "operationId": "captureSelection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptureSelectionRequest" }, "example": { "companies": { "q": "Red Bull", "limit": 25 } } } }, "required": true }, "responses": { "200": { "description": "Captured selection handle and stored preview reference.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapturedSelectionDto" }, "example": { "selection": { "id": "selection-example", "revision": 1, "fingerprint": "sha256-example", "count": 1, "expiresAt": "2026-10-18T12:00:00Z" }, "preview": { "id": "0123456789abcdef0123456789abcdef", "operationId": "searchCompanies", "bytes": 180, "expiresAt": "2026-10-18T12:00:00Z" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "capture_selection", "x-toolTitle": "Feste Auswahl erfassen" } }, "/api/v2/me/results/{id}": { "get": { "tags": [ "workspace.results" ], "summary": "Read a stored operation result", "description": "Read an unchanged stored result or a specific JSON Pointer section without repeating the source query. Arrays are paginated; large objects expose field paths. Follow nextOffset or choose a field path. References are reader-scoped and expire after 24 hours. This is the stored snapshot, not live data. Free for keys and sessions. Responses are private, no-store.", "operationId": "readResult", "parameters": [ { "name": "id", "in": "path", "description": "Server-issued result reference, not a tool call ID or selection ID.", "required": true, "schema": { "type": "string" }, "example": "0123456789abcdef0123456789abcdef" }, { "name": "path", "in": "query", "description": "JSON Pointer to a section, for example /items or /items/0/people. Omit path, use null or an empty string to read the root. A single slash addresses a property with an empty name, not the root.", "schema": { "type": "string", "default": null }, "example": "/items" }, { "name": "offset", "in": "query", "description": "Offset into the selected stored array; use nextOffset from the previous response.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "example": 0 }, { "name": "limit", "in": "query", "description": "Maximum whole rows, 1–100 (default 25). Response byte budget may reduce the page size.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 } ], "responses": { "200": { "description": "Unchanged result section or bounded page with continuation.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultSlice" }, "example": { "id": "0123456789abcdef0123456789abcdef", "path": "/items", "data": [ { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" } ], "total": 1, "complete": true, "fields": [], "expiresAt": "2026-10-18T12:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "read_result", "x-toolTitle": "Gespeichertes Ergebnis lesen" } }, "/api/v2/me/fields": { "get": { "tags": [ "workspace.data.fields" ], "summary": "List workspace fields", "description": "Return a cursor page of workspace field definitions and their stable keys. Optional listId restricts the result to that list's columns. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listFields", "parameters": [ { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "listId", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfFieldDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_fields", "x-toolTitle": "Eigene Felder lesen" }, "post": { "tags": [ "workspace.data.fields" ], "summary": "Create a workspace field", "description": "Create a typed workspace field with a key derived from its label. Key collisions receive a suffix. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createField", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFieldDto" }, "example": { "label": "Status", "type": "options", "options": [ "Lead", "Kunde" ] } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDto" }, "example": { "id": "fld_fixture", "key": "status", "label": "Status", "type": "options", "options": [ "Lead", "Kunde" ], "clearedValues": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "create_field", "x-toolTitle": "Eigenes Feld erstellen" } }, "/api/v2/me/fields/{id}": { "patch": { "tags": [ "workspace.data.fields" ], "summary": "Update a workspace field", "description": "Update a workspace field's label, type or options without changing its key. Option renames update stored values together. Invalid conversions require clearInvalid. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateField", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "label" ] }, { "required": [ "type" ] }, { "required": [ "options" ] }, { "required": [ "unit" ] }, { "required": [ "renames" ] }, { "required": [ "clearInvalid" ] } ], "properties": { "label": { "type": [ "null", "string" ], "default": null }, "type": { "enum": [ null, "text", "options", "number", "date", "bool" ], "type": [ "null", "string" ], "description": "Value type: text, options, number, date or bool. Omit or use null to retain the existing type.", "default": null }, "options": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Choices for type options only: up to 1000 distinct nonempty values, each at most 200 characters. Omit or use null to retain existing choices or infer them when converting.", "default": null }, "unit": { "type": [ "null", "string" ], "description": "Display unit for type number only, at most 100 characters. Omit or use null to retain the existing unit.", "default": null }, "renames": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "default": null }, "clearInvalid": { "type": "boolean", "default": false } }, "additionalProperties": false }, "example": { "label": "Kundenstatus" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDto" }, "example": { "id": "fld_fixture", "key": "status", "label": "Status", "type": "options", "options": [ "Lead", "Kunde" ], "clearedValues": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_field", "x-toolTitle": "Eigenes Feld bearbeiten" }, "delete": { "tags": [ "workspace.data.fields" ], "summary": "Delete a workspace field", "description": "Delete a workspace field with its values and the list columns that show it. List rules cannot filter by workspace fields, so no list definition depends on one. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "deleteField", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "204": { "description": "No Content", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "delete_field", "x-toolTitle": "Eigenes Feld löschen" } }, "/api/v2/me/lists/{id}/imports": { "post": { "tags": [ "workspace.lists.transfer" ], "summary": "Prepare a CSV import report", "description": "Create a 24-hour review draft and match report from browser-parsed CSV rows for a workspace list. Entries, own records, options and values are not written until confirmation. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createImport", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportDto" }, "example": { "fileName": "contacts.csv", "mapping": { "Name": "name" }, "rows": [ { "Name": "Red Bull GmbH" } ] } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "status": "review", "fileName": "contacts.csv", "rows": 1, "expiresAt": "2026-10-02T10:00:00Z", "summary": { "matched": 1, "ambiguous": 0, "unmatched": 0, "alreadyPresent": 0 }, "report": { "items": [] }, "fields": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "create_import", "x-toolTitle": "Import vorbereiten" } }, "/api/v2/me/lists/{id}/imports/{importId}": { "get": { "tags": [ "workspace.lists.transfer" ], "summary": "Get an import report", "description": "Return an import draft's summary, field conversion warnings and cursor-paged rows. Rows can be filtered by match status; expired drafts return 410 import_expired. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "getImport", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "importId", "in": "path", "description": "Optional collection filter.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "status", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "status": "review", "fileName": "contacts.csv", "rows": 1, "expiresAt": "2026-10-02T10:00:00Z", "summary": { "matched": 1, "ambiguous": 0, "unmatched": 0, "alreadyPresent": 0 }, "report": { "items": [] }, "fields": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_import", "x-toolTitle": "Import prüfen" }, "patch": { "tags": [ "workspace.lists.transfer" ], "summary": "Choose import matches", "description": "Update review draft rows with a register akteId or keepOwn choice. This does not add list entries or own records. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateImport", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "importId", "in": "path", "description": "Optional collection filter.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateImportDto" }, "example": { "rows": [ { "row": 1, "keepOwn": true } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "status": "review", "fileName": "contacts.csv", "rows": 1, "expiresAt": "2026-10-02T10:00:00Z", "summary": { "matched": 1, "ambiguous": 0, "unmatched": 0, "alreadyPresent": 0 }, "report": { "items": [] }, "fields": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_import", "x-toolTitle": "Import bearbeiten" } }, "/api/v2/me/lists/{id}/imports/{importId}/confirm": { "post": { "tags": [ "workspace.lists.transfer" ], "summary": "Confirm a CSV import", "description": "Add matched register records and reused or new own records to the list, together with field values and new options. Unresolved ambiguous rows retain candidate IDs. Confirmation is retry-safe without an Idempotency-Key; over 500 rows returns a durable job. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "confirmImport", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "importId", "in": "path", "description": "Optional collection filter.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmImportDto" }, "example": { "imported": 1, "summary": { "matched": 1, "ambiguous": 0, "unmatched": 0, "alreadyPresent": 0 } } } } }, "202": { "description": "Accepted", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmImportDto" }, "example": { "imported": 1, "summary": { "matched": 1, "ambiguous": 0, "unmatched": 0, "alreadyPresent": 0 } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "confirm_import", "x-toolTitle": "Import bestätigen" } }, "/api/v2/me/jobs/{id}": { "get": { "tags": [ "workspace.lists.entries" ], "summary": "Get a list write job", "description": "Return the status and durable progress of a bulk list write job in this workspace. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "getJob", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWriteJobDto" }, "example": { "id": "6477af28-5262-4495-992b-cb457dbb2b31", "kind": "addEntries", "listId": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "status": "running", "total": 1001, "done": 500, "failed": 0, "startedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_job", "x-toolTitle": "Auftragsstatus lesen" } }, "/api/v2/me/lists/rules/preview": { "post": { "tags": [ "workspace.lists.rules" ], "summary": "Preview a rule for a new list", "description": "Validate a rule before creating a list. Returns the same price, next run, match count and bounded sample as previewRule, without requiring or creating a list. Does not save, execute or charge. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "previewNewListRule", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRuleDto" }, "example": { "excluded": true } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleQuoteDto" }, "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "preview_new_list_rule", "x-toolTitle": "Regel für neue Liste prüfen" } }, "/api/v2/me/lists/{id}/rules/preview": { "post": { "tags": [ "workspace.lists.rules" ], "summary": "Preview a rule", "description": "Validate a typed rule for an existing list identified by id, before saving it to that list. Creating a new list with rules uses createList and does not require this existing-list preview. Query rules return credits per execution, nextRunAt, matches (how many companies a run would newly add now, counted up to 10000) and at most five of them as a sample; neither is a reserved selection. Notification rules return zero credits, no matches and no sample. Does not save or execute. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "previewRule", "parameters": [ { "name": "id", "in": "path", "description": "ID of an existing list in the authorized workspace, returned by listLists or createList. A new list has no ID until creation; createList accepts its initial rules directly.", "required": true, "schema": { "type": "string", "description": "ID of an existing list in the authorized workspace, returned by listLists or createList. A new list has no ID until creation; createList accepts its initial rules directly." }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRuleDto" }, "example": { "rule": { "operationId": "applyListQuery", "schemaVersion": 1, "enabled": true, "trigger": "schedule", "triggerPayload": { "every": "daily", "at": "06:00", "timezone": "Europe/Vienna" }, "payload": { "definition": { "subject": "company", "filterVersion": 1, "where": { "and": [] } } } }, "runNow": false } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleQuoteDto" }, "example": { "credits": 10, "nextRunAt": "2026-10-02T04:00:00Z", "matches": 128, "matchesCapped": false, "items": [ { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" } ] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "preview_rule", "x-toolTitle": "Regel prüfen" } }, "/api/v2/me/lists/{id}/rules": { "get": { "tags": [ "workspace.lists.rules" ], "summary": "List rules", "description": "Read cursor-paged rules with typed rule configuration, revision, credits per execution and latest query run. Filter operationId to applyListQuery or notifyListEntries; keep this filter unchanged when paging. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listRules", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "operationId", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfRuleDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_rules", "x-toolTitle": "Regeln lesen" }, "post": { "tags": [ "workspace.lists.rules" ], "summary": "Create a rule", "description": "Save one typed rule: applyListQuery for company queries, or notifyListEntries for one inApp/email channel. runNow optionally starts an enabled query at the quoted list-update price; recurrence is controlled separately by its trigger. Notification channels are unique per list. Creation is free; scheduled and manual executions charge the server list-update price. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createRule", "parameters": [ { "name": "id", "in": "path", "description": "ID of an existing list in the authorized workspace, returned by listLists or createList. A new list has no ID until creation; createList accepts its initial rules directly.", "required": true, "schema": { "type": "string", "description": "ID of an existing list in the authorized workspace, returned by listLists or createList. A new list has no ID until creation; createList accepts its initial rules directly." }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRuleDto" }, "example": { "rule": { "operationId": "applyListQuery", "schemaVersion": 1, "enabled": true, "trigger": "schedule", "triggerPayload": { "every": "daily", "at": "06:00", "timezone": "Europe/Vienna" }, "payload": { "definition": { "subject": "company", "filterVersion": 1, "where": { "and": [] } } } }, "runNow": false } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleDto" }, "example": { "id": "rule_fixture", "listId": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "rule": { "operationId": "applyListQuery", "schemaVersion": 1, "enabled": true, "trigger": "schedule", "triggerPayload": { "every": "daily", "at": "06:00", "timezone": "Europe/Vienna" }, "payload": { "definition": { "subject": "company", "filterVersion": 1, "where": { "and": [] } } } }, "revision": "1", "credits": 10, "nextRunAt": "2026-10-02T04:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "create_rule", "x-toolTitle": "Regel erstellen" } }, "/api/v2/me/lists/{id}/rules/{ruleId}": { "patch": { "tags": [ "workspace.lists.rules" ], "summary": "Update a rule", "description": "Replace a rule configuration using its unchanged revision from list_rules. Function and notification channel stay fixed. enabled:false pauses it; entries and values remain. Re-enabling notifications starts at the current event horizon. Changes fence older executions. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "ruleId", "in": "path", "description": "Stable query rule ID within this workspace list.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRuleDto" }, "example": { "revision": "1", "rule": { "operationId": "applyListQuery", "schemaVersion": 1, "enabled": true, "trigger": "schedule", "triggerPayload": { "every": "daily", "at": "06:00", "timezone": "Europe/Vienna" }, "payload": { "definition": { "subject": "company", "filterVersion": 1, "where": { "and": [] } } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuleDto" }, "example": { "id": "rule_fixture", "listId": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "rule": { "operationId": "applyListQuery", "schemaVersion": 1, "enabled": true, "trigger": "schedule", "triggerPayload": { "every": "daily", "at": "06:00", "timezone": "Europe/Vienna" }, "payload": { "definition": { "subject": "company", "filterVersion": 1, "where": { "and": [] } } } }, "revision": "1", "credits": 10, "nextRunAt": "2026-10-02T04:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_rule", "x-toolTitle": "Regel bearbeiten" }, "delete": { "tags": [ "workspace.lists.rules" ], "summary": "Delete a rule", "description": "Delete one rule while keeping entries, values and historical runs. Copy its revision string from list_rules unchanged. Pause instead with update_rule. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "ruleId", "in": "path", "description": "Stable query rule ID within this workspace list.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "revision", "in": "query", "description": "Last reviewed rule revision; a changed rule returns 409 and is not deleted.", "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "204": { "description": "No Content", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "delete_rule", "x-toolTitle": "Regel löschen" } }, "/api/v2/me/lists/{id}/rules/{ruleId}/run": { "post": { "tags": [ "workspace.lists.rules" ], "summary": "Evaluate a rule", "description": "Run an enabled applyListQuery rule using its unchanged revision from list_rules. dryRun previews; execution charges the list-update price, adds matches and preserves entries/exclusions. Notification rules run only from events. Read status with list_runs and additions with list_entries(runId). Reuse Idempotency-Key after a lost response. Additions respect list-wide exclusions and never remove members. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "runRule", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "ruleId", "in": "path", "description": "Stable query rule ID within this workspace list.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunRuleDto" }, "example": { "revision": "1", "dryRun": false } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationDto" }, "example": { "run": { "id": "run_5519", "trigger": "manual", "evaluationDate": "2026-10-01", "startedAt": "2026-10-01T04:00:00Z", "finishedAt": "2026-10-01T04:00:01Z", "added": 4, "status": "succeeded", "baseline": false, "credits": 10 } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0, "description": "Creating a list and saving a rule are free. Setting runNow:true on a rule requests an initial execution at the listUpdate price from GET /me/credits. Later manual and scheduled rule executions use the same price, including sessions. Rule dryRun costs 1 credit for keys and is free for sessions." }, "x-exposure": "customer", "x-toolName": "run_rule", "x-toolTitle": "Regel ausführen" } }, "/api/v2/me/lists": { "get": { "tags": [ "workspace.lists.management" ], "summary": "List workspace lists", "description": "Return a cursor page of workspace lists with membership counts. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listLists", "parameters": [ { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "selectedIds", "in": "query", "description": "Optional collection filter.", "schema": { "type": "array", "items": { "type": "string", "default": null }, "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "selectionListId", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "selectionQ", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfListDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_lists", "x-toolTitle": "Meine Listen" }, "post": { "tags": [ "workspace.lists.management" ], "summary": "Create a list", "description": "Create a list atomically with optional items (up to 500) and rules (up to 100). Each rule contains its typed rule configuration and runNow flag. Use applyListQuery for reusable queries instead of enumerating matches. At most one enabled query may runNow; trigger manual is one-time, trigger schedule adds independent recurrence. Notification rules use notifyListEntries with one channel each. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createList", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListDto" }, "example": { "name": "Contacts" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "name": "Contacts", "revision": "rev_1", "stats": { "members": 0, "matched": 0, "unmatched": 0, "excluded": 0 } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0, "description": "Creating a list and saving a rule are free. Setting runNow:true on a rule requests an initial execution at the listUpdate price from GET /me/credits. Later manual and scheduled rule executions use the same price, including sessions. Rule dryRun costs 1 credit for keys and is free for sessions." }, "x-exposure": "customer", "x-toolName": "create_list", "x-toolTitle": "Liste erstellen" } }, "/api/v2/me/lists/{id}": { "get": { "tags": [ "workspace.lists.management" ], "summary": "Get a list", "description": "Read list metadata, statistics, latest run and rev_ revision for update_list. Independent rules and their revision strings: list_rules. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "getList", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "name": "Contacts", "revision": "rev_1", "stats": { "members": 0, "matched": 0, "unmatched": 0, "excluded": 0 } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_list", "x-toolTitle": "Liste lesen" }, "patch": { "tags": [ "workspace.lists.management" ], "summary": "Update a list", "description": "Rename a list or change its color. Add independent rules with create_rule; edit or pause with update_rule. Optional If-Match checks the revision and returns 412 revision_conflict without saving if it changed. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateList", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "If-Match", "in": "header", "description": "Optional list revision, quoted or unquoted. If the list changed, returns 412 revision_conflict and saves nothing.", "schema": { "type": "string" }, "example": "\"rev_1\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "name" ] }, { "required": [ "color" ] } ], "properties": { "name": { "type": [ "null", "string" ], "default": null }, "color": { "type": [ "null", "string" ], "default": null } }, "additionalProperties": false }, "example": { "name": "Leads" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDto" }, "example": { "id": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3", "name": "Contacts", "revision": "rev_1", "stats": { "members": 0, "matched": 0, "unmatched": 0, "excluded": 0 } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "412": { "description": "The object changed since it was read.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_list", "x-toolTitle": "Liste bearbeiten" }, "delete": { "tags": [ "workspace.lists.management" ], "summary": "Delete a list", "description": "Delete a workspace list, its rules and entries while keeping workspace own records. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "deleteList", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "204": { "description": "No Content", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "delete_list", "x-toolTitle": "Liste löschen" } }, "/api/v2/me/lists/{id}/entries": { "get": { "tags": [ "workspace.lists.entries" ], "summary": "List entries", "description": "Return a filtered cursor page of visible list entries with their column values. Sort by a column or addedAt; empty values sort last. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listEntries", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "q", "in": "query", "description": "Case-insensitive name text.", "schema": { "type": "string", "default": null }, "example": "Nordic" }, { "name": "match", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "unmatched" }, { "name": "origin", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "manual" }, { "name": "excluded", "in": "query", "description": "Optional collection filter.", "schema": { "type": "boolean", "default": null }, "example": false }, { "name": "sort", "in": "query", "description": "Any public column path or fields.; prefix with minus for descending. Empty values last.", "schema": { "type": "string", "default": "name" }, "example": "name" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "runId", "in": "query", "description": "Only entries added in this list's run.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfListEntryDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_entries", "x-toolTitle": "Listeneinträge lesen" }, "post": { "tags": [ "workspace.lists.entries" ], "summary": "Add list entries", "description": "Add register records, workspace own records or inline own records to a list. Re-adding a subject lifts its exclusion; existing subjects report alreadyPresent. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "addEntries", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "items" ] }, { "required": [ "listId" ] }, { "required": [ "query" ] } ], "properties": { "items": { "maxItems": 500, "minItems": 1, "type": [ "null", "array" ], "items": { "type": "object", "anyOf": [ { "required": [ "id" ] }, { "required": [ "ownRecordId" ] }, { "required": [ "ownRecord" ] } ], "properties": { "id": { "type": [ "null", "string" ], "default": null }, "ownRecordId": { "type": [ "null", "string" ], "default": null }, "ownRecord": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOwnRecordDto" } ], "default": null } }, "additionalProperties": false }, "default": null }, "listId": { "type": [ "null", "string" ], "default": null }, "query": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false, "default": null }, "q": { "type": [ "null", "string" ], "default": null }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears.", "default": null } }, "additionalProperties": false }, "example": { "items": [ { "id": "fnr:56247t" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntriesWriteDto" }, "example": { "items": [] } } } }, "202": { "description": "Accepted", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntriesWriteDto" }, "example": { "items": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "add_entries", "x-toolTitle": "Einträge hinzufügen" } }, "/api/v2/me/lists/{id}/entries/{entryId}": { "patch": { "tags": [ "workspace.lists.entries" ], "summary": "Update a list entry", "description": "Set a list entry's excluded state or its typed field values. Values belong to the subject and appear on every list; exclusion prevents dynamic re-addition until lifted. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateEntry", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "entryId", "in": "path", "description": "List-local entry ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntryDto" }, "example": { "values": { "status": "Kunde" } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEntryDto" }, "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_entry", "x-toolTitle": "Listeneintrag bearbeiten" } }, "/api/v2/me/lists/{id}/entries/remove": { "post": { "tags": [ "workspace.lists.entries" ], "summary": "Remove list entries", "description": "Exclude selected list entries by entry IDs, register IDs or a bulk selection. Excluded members do not return until explicitly re-added. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "removeEntries", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "entryIds" ] }, { "required": [ "ids" ] }, { "required": [ "listId" ] }, { "required": [ "query" ] } ], "properties": { "entryIds": { "maxItems": 500, "minItems": 1, "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "ids": { "maxItems": 500, "minItems": 1, "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "listId": { "type": [ "null", "string" ], "default": null }, "query": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false, "default": null }, "q": { "type": [ "null", "string" ], "default": null } }, "additionalProperties": false }, "example": { "ids": [ "fnr:56247t" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntriesWriteDto" }, "example": { "items": [] } } } }, "202": { "description": "Accepted", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntriesWriteDto" }, "example": { "items": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "remove_entries", "x-toolTitle": "Einträge entfernen" } }, "/api/v2/me/lists/{id}/columns": { "get": { "tags": [ "workspace.lists.entries" ], "summary": "List a list's columns", "description": "Return the list's ordered register and workspace-field columns. Name stays first. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listColumns", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColumnsDto" }, "example": { "items": [ { "key": "name", "kind": "synced", "path": "name", "label": "Name", "hidden": false } ] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_columns", "x-toolTitle": "Listenspalten lesen" }, "put": { "tags": [ "workspace.lists.entries" ], "summary": "Replace a list's columns", "description": "Replace a list's column order, labels and visibility. Public paths must be columnable and own fields must belong to this workspace; name remains first and visible. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "replaceColumns", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceColumnsDto" }, "example": { "items": [ { "kind": "field", "field": "status" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColumnsDto" }, "example": { "items": [ { "key": "name", "kind": "synced", "path": "name", "label": "Name", "hidden": false } ] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "replace_columns", "x-toolTitle": "Listenspalten speichern" } }, "/api/v2/me/lists/{id}/entries/search": { "post": { "tags": [ "workspace.lists.entries" ], "summary": "Search list entries", "description": "Filter a list's entries with the shared filter compiler, including workspace-field and list predicates. Results use keyset paging with empty values last; limit 0 counts for free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "searchEntries", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrySearchDto" }, "example": { "where": { "field": "fields.status", "op": "in", "value": [ "Kunde" ] }, "limit": 25 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfListEntryDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_entries", "x-toolTitle": "Listeneinträge suchen" } }, "/api/v2/me/lists/{id}/runs": { "get": { "tags": [ "workspace.lists.rules" ], "summary": "List list runs", "description": "Return a newest-first cursor page of a list's update runs with counts, evaluation date, credits and status. Optional trigger and status filters narrow the result. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listRuns", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "trigger", "in": "query", "description": "Filter by scheduled, manual, created or entriesChanged.", "schema": { "type": "string", "default": null }, "example": "scheduled" }, { "name": "status", "in": "query", "description": "Filter by running, succeeded, failed or skipped.", "schema": { "type": "string", "default": null }, "example": "succeeded" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfListRunDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_runs", "x-toolTitle": "Regelausführungen lesen" } }, "/api/v2/me/lists/{id}/events": { "get": { "tags": [ "workspace.lists.rules" ], "summary": "List list events", "description": "Return a list's membership, identity-correction and skipped-update events in ascending sequence order. The after sequence never expires; type and runId can narrow the events. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listListEvents", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "after", "in": "query", "description": "Last processed sequence; never expires.", "schema": { "type": "integer", "format": "int64", "default": 0 }, "example": "0" }, { "name": "type", "in": "query", "description": "Comma-separated entry.added, entry.removed, run.skipped or entry.flagged.", "schema": { "type": "string", "default": null }, "example": "entry.added" }, { "name": "limit", "in": "query", "description": "Page size, 1 to 100; default 25.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "runId", "in": "query", "description": "Only entries added in this list's run.", "schema": { "type": "string", "default": null }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfListEventDto" }, "example": { "items": [], "nextCursor": "0" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_list_events", "x-toolTitle": "Listenänderungen lesen" } }, "/api/v2/me/search/geo": { "post": { "tags": [ "workspace.data.records" ], "summary": "Map my search results", "description": "Use listId or query; together they filter only existing list members. q narrows the result further. bbox is [minLng,minLat,maxLng,maxLat], zoom 0–20. Dense cells are SQL clusters; singleton cells become points from zoom 10. noLocation counts every match without visible coordinates, regardless of bbox. entries and withoutLocation are bounded cursor pages. Session searches are free; keys pay one credit. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "searchMineGeo", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MineGeoRequest" }, "example": { "query": { "subject": "company", "where": { "field": "fields.status", "op": "in", "value": [ "Kunde" ] }, "filterVersion": 1 }, "bbox": [ 9.5, 46.4, 17.2, 49 ], "zoom": 7 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MineGeoResponse" }, "example": { "clusters": [], "points": [], "noLocation": 0, "entries": { "items": [] }, "withoutLocation": { "items": [] } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_mine_geo", "x-toolTitle": "Eigene Daten auf der Karte suchen" } }, "/api/v2/me/search": { "post": { "tags": [ "workspace.data.records" ], "summary": "Search my data", "description": "Search a workspace list or a company query using public, workspace-field and list predicates. Optional ownRecords includes workspace own records; columns selects public column values. Results use keyset paging with empty values last; limit 0 counts for free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "searchMine", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MineSearchRequest" }, "example": { "query": { "subject": "company", "where": { "field": "fields.status", "op": "in", "value": [ "Kunde" ] }, "filterVersion": 1 }, "sort": "fields.status", "limit": 25 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfMineSearchRow" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_mine", "x-toolTitle": "Eigene Daten durchsuchen" } }, "/api/v2/me/entities/{id}": { "get": { "tags": [ "workspace.data.records" ], "summary": "Get my entity data", "description": "Resolve a register ID, alias or workspace own-record ID and return its workspace field values, with the first 25 memberships, notes and activity items. resolveSourceValues defaults to true; false returns saved custom and Firmenakte fields without projecting current register values. Continuation cursors use the corresponding collection paths. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "getMyEntity", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte ID, register alias such as fnr:56247t, or workspace own-record ID.", "required": true, "schema": { "type": "string", "description": "Firmenakte ID, register alias such as fnr:56247t, or workspace own-record ID." }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "resolveSourceValues", "in": "query", "description": "Resolve current register values for source fields. Defaults to true; false returns only stored workspace fields, including saved Firmenakte fields, without projecting register values.", "schema": { "type": "boolean", "description": "Resolve current register values for source fields. Defaults to true; false returns only stored workspace fields, including saved Firmenakte fields, without projecting register values.", "default": true }, "example": false }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyEntityDto" }, "example": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH", "lists": { "items": [] }, "values": {}, "notes": { "items": [] }, "activity": { "items": [] }, "filledFields": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_my_entity", "x-toolTitle": "Eigene Angaben lesen" }, "patch": { "tags": [ "workspace.data.records" ], "summary": "Update my entity values", "description": "Set an entity's workspace-wide typed field values, even without list membership. Null clears a value. resolveSourceValues defaults to true; false returns saved source-field values without projecting current register values. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateMyEntity", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "resolveSourceValues", "in": "query", "description": "Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.", "schema": { "type": "boolean", "description": "Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.", "default": true }, "example": false }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetEntityValuesDto" }, "example": { "values": { "status": "Kunde" } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityValuesDto" }, "example": { "values": { "status": "Kunde" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_my_entity", "x-toolTitle": "Eigene Feldwerte speichern" } }, "/api/v2/me/entities/{id}/lists": { "get": { "tags": [ "workspace.data.records" ], "summary": "List an entity's lists", "description": "Return a cursor page of an entity's workspace list memberships, including excluded lists. Memberships include exclusion state and the membership origin. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listEntityLists", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfEntityListDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_entity_lists", "x-toolTitle": "Listenzugehörigkeit lesen" } }, "/api/v2/me/entities/{id}/activity": { "get": { "tags": [ "workspace.data.records" ], "summary": "List an entity's activity", "description": "Return a newest-first cursor page of an entity's workspace activity with readable summaries. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listEntityActivity", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfEntityActivityDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_entity_activity", "x-toolTitle": "Änderungsverlauf lesen" } }, "/api/v2/me/notes": { "get": { "tags": [ "workspace.data.notes" ], "summary": "List my notes", "description": "Return a cursor page of workspace notes on the requested subject. Suppressed subjects are hidden. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listNotes", "parameters": [ { "name": "subject", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfNoteDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_notes", "x-toolTitle": "Notizen lesen" }, "post": { "tags": [ "workspace.data.notes" ], "summary": "Create a note", "description": "Create a workspace note on a subject resolved from a canonical ID, alias or workspace own record. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createNote", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNoteDto" }, "example": { "subject": "C-KX1V-B12Z", "text": "Call on Monday." } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" }, "example": { "id": "nte_fixture", "subject": { "id": "C-KX1V-B12Z", "type": "company", "kind": "akte", "name": "Red Bull GmbH" }, "text": "Call on Monday.", "at": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "create_note", "x-toolTitle": "Notiz hinzufügen" } }, "/api/v2/me/notes/{id}": { "patch": { "tags": [ "workspace.data.notes" ], "summary": "Update a note", "description": "Update the text of a workspace-owned note. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateNote", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" }, "example": { "text": "Called; offer follows." } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" }, "example": { "id": "nte_fixture", "subject": { "id": "C-KX1V-B12Z", "type": "company", "kind": "akte", "name": "Red Bull GmbH" }, "text": "Call on Monday.", "at": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_note", "x-toolTitle": "Notiz bearbeiten" }, "delete": { "tags": [ "workspace.data.notes" ], "summary": "Delete a note", "description": "Delete a workspace-owned note. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "deleteNote", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "204": { "description": "No Content", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "delete_note", "x-toolTitle": "Notiz löschen" } }, "/api/v2/me/own-records": { "get": { "tags": [ "workspace.data.records" ], "summary": "List my own records", "description": "Return a cursor page of workspace own records ordered by name. Ambiguous records retain their candidate IDs. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "listOwnRecords", "parameters": [ { "name": "match", "in": "query", "description": "Optional collection filter.", "schema": { "type": "string", "default": null }, "example": "unmatched" }, { "name": "q", "in": "query", "description": "Case-insensitive name text.", "schema": { "type": "string", "default": null }, "example": "Nordic" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32", "default": 25 }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page; expires after 24 hours.", "schema": { "type": "string", "default": null }, "example": "opaque-cursor" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfOwnRecordDto" }, "example": { "items": [], "total": 0 } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_own_records", "x-toolTitle": "Eigene Datensätze lesen" }, "post": { "tags": [ "workspace.data.records" ], "summary": "Create an own record", "description": "Create a workspace own record with its supplied details, or reuse one with the same normalized name. Ambiguous register candidates are retained. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "createOwnRecord", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOwnRecordDto" }, "example": { "name": "Nordic Packaging AB", "sourceValues": { "country": "SE", "seat.city": "Malmö" } } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnRecordDto" }, "example": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "create_own_record", "x-toolTitle": "Eigenen Datensatz erstellen" } }, "/api/v2/me/own-records/{id}": { "get": { "tags": [ "workspace.data.records" ], "summary": "Get an own record", "description": "Return an own record in the caller's workspace. resolveSourceValues defaults to true; false returns saved source-field values without projecting current register values. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "getOwnRecord", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "resolveSourceValues", "in": "query", "description": "Resolve current register values for source fields. Defaults to true; false returns only saved workspace fields.", "schema": { "type": "boolean", "description": "Resolve current register values for source fields. Defaults to true; false returns only saved workspace fields.", "default": true }, "example": false }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnRecordDto" }, "example": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_own_record", "x-toolTitle": "Eigenen Datensatz lesen" }, "patch": { "tags": [ "workspace.data.records" ], "summary": "Update an own record", "description": "Update a workspace own record's name, note, workspace field values and Firmenakte field values (sourceValues). Omitted values keep theirs; changes are visible on every list. resolveSourceValues defaults to true; false returns saved source-field values without projecting current register values. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "updateOwnRecord", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "resolveSourceValues", "in": "query", "description": "Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.", "schema": { "type": "boolean", "description": "Resolve current register values in the response. Defaults to true; false returns only saved workspace source-field values.", "default": true }, "example": false }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "anyOf": [ { "required": [ "name" ] }, { "required": [ "note" ] }, { "required": [ "values" ] }, { "required": [ "sourceValues" ] } ], "properties": { "name": { "type": [ "null", "string" ], "default": null }, "note": { "type": [ "null", "string" ], "default": null }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears.", "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values of Firmenakte fields by field catalog path; null clears one. Omitted fields keep their values.", "default": null } }, "additionalProperties": false }, "example": { "name": "Nordic Packaging AB" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnRecordDto" }, "example": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "update_own_record", "x-toolTitle": "Eigenen Datensatz bearbeiten" }, "delete": { "tags": [ "workspace.data.records" ], "summary": "Delete an own record", "description": "Delete a workspace own record and remove it from every list. Register records are not deleted. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "deleteOwnRecord", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "responses": { "204": { "description": "No Content", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "example": { "entryId": "7b802e29-cb6c-4e13-ad65-09790e3790d1", "ownRecord": { "id": "22adebac-583c-43ea-b49f-2587601a1e05", "name": "Nordic Packaging AB", "match": { "status": "unmatched" } }, "match": { "status": "unmatched" }, "origin": "manual", "excluded": false, "addedAt": "2026-10-01T10:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "delete_own_record", "x-toolTitle": "Eigenen Datensatz löschen" } }, "/api/v2/me/exports": { "post": { "tags": [ "workspace.lists.transfer" ], "summary": "Start an export", "description": "Freeze a list or query selection now and write its values in the background. All entries, including workspace own records, are exported in bounded pages without a row cap. Defaults to the list's columns or name, city, industry and registration date. people exports one row per person of a query with subject person and no listId. Sessions and metered keys pay the export_rows price per begun 1,000 frozen rows, at least the export_minimum price (current values: prices.exportRows and prices.exportMinimum in GET /api/v2/me/credits); failed jobs are refunded. Poll Location for rowsDone of rows; completed files expire after 24 hours. Optional Idempotency-Key replays the same job free.", "operationId": "createExport", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExportRequest" }, "example": { "listId": "list_example", "format": "csv" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } }, "Location": { "description": "Job polling URL.", "schema": { "type": "string" } }, "Retry-After": { "description": "Suggested poll delay in seconds.", "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportDto" }, "example": { "id": "export_example", "status": "queued", "format": "csv", "createdAt": "2026-10-03T10:00:00Z", "asOf": "2026-10-03T10:00:00Z", "rows": 214, "rowsDone": 0, "credits": 3, "columns": [ "name", "seat.city" ] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "expensive", "cost": 3 }, "x-exposure": "customer", "x-toolName": "create_export", "x-toolTitle": "Export erstellen" }, "get": { "tags": [ "workspace.lists.transfer" ], "summary": "List exports", "description": "Read this workspace's export jobs, newest first. Foreign IDs are not found. Cursor-paged collections; free; private, no-store.", "operationId": "listExports", "parameters": [ { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page.", "schema": { "type": "string" }, "example": "export_example" }, { "name": "listId", "in": "query", "description": "Only exports started from this list.", "schema": { "type": "string" }, "example": "list_example" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfExportDto" }, "example": { "items": [] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_exports", "x-toolTitle": "Exporte lesen" } }, "/api/v2/me/exports/{id}": { "get": { "tags": [ "workspace.lists.transfer" ], "summary": "Get an export", "description": "Read this workspace's export jobs, newest first. Foreign IDs are not found. Cursor-paged collections; free; private, no-store.", "operationId": "getExport", "parameters": [ { "name": "id", "in": "path", "description": "Resource key.", "required": true, "schema": { "type": "string" }, "example": "export_example" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportDto" }, "example": { "id": "export_example", "status": "queued", "format": "csv", "createdAt": "2026-10-03T10:00:00Z", "asOf": "2026-10-03T10:00:00Z", "rows": 214, "rowsDone": 0, "credits": 3, "columns": [ "name", "seat.city" ] } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_export", "x-toolTitle": "Exportstatus lesen" } }, "/api/v2/me/exports/{id}/file": { "get": { "tags": [ "workspace.lists.transfer" ], "summary": "Download an export file", "description": "Stream the immutable CSV or XLSX belonging to this workspace, within 24 hours of completion. Foreign IDs are not found. Free; private, no-store. Errors remain problem JSON.", "operationId": "getExportFile", "parameters": [ { "name": "id", "in": "path", "description": "Resource key.", "required": true, "schema": { "type": "string" }, "example": "export_example" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "text/csv": { "schema": { "type": "string", "format": "binary" }, "example": "Name,Art\nExample,Firma" }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" }, "example": "Binary file content" } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_export_file", "x-toolTitle": "Export herunterladen" } }, "/api/v2/me/lists/{id}/notification-rules": { "put": { "tags": [ "workspace.lists.rules" ], "summary": "Set notification channels atomically", "description": "Save both channel settings atomically using reviewed rule IDs and revisions, or explicit nulls for absent channels. A concurrent change returns 409. Re-enabling starts at the current event horizon. Free. Responses use private, no-store; optional Idempotency-Key replays the first answer free for 24 hours. Foreign workspace resources are not found.", "operationId": "setNotificationRules", "parameters": [ { "name": "id", "in": "path", "description": "Workspace resource ID.", "required": true, "schema": { "type": "string" }, "example": "6cee7bba-ff15-4b78-a7f9-bbd8c2ad76f3" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "collection-write-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNotificationRulesDto" }, "example": { "inApp": { "enabled": true, "id": null, "revision": null }, "email": { "enabled": false, "id": null, "revision": null } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRulesDto" }, "example": { "inApp": null, "email": null } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "set_notification_rules", "x-toolTitle": "Benachrichtigungskanäle einstellen" } }, "/api/v2/me": { "get": { "tags": [ "workspace.access" ], "summary": "Get my account", "description": "Read or manage the credential's workspace. Responses are private, no-store and cost no credits. Accepts an API key or a dashboard session.", "operationId": "getMe", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "account-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeDto" }, "example": { "workspace": { "id": "wsp_0123456789abcdef", "name": "Example", "plan": "free", "role": "owner" }, "channel": "api", "apiKey": { "id": "0123456789abcdef", "name": "Standard" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_me", "x-toolTitle": "Workspace lesen" } }, "/api/v2/me/credits": { "get": { "tags": [ "workspace.access" ], "summary": "Get my credits", "description": "Read or manage the credential's workspace. Responses are private, no-store and cost no credits. Accepts an API key or a dashboard session.", "operationId": "getCredits", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "account-write-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeCreditsDto" }, "example": { "week": "2026-W40", "allowance": 50, "used": 8, "topUp": 100, "balance": 142, "resetsAt": "2026-10-05T00:00:00Z" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "403": { "description": "This operation needs a dashboard session.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Always zero.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "account", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_credits", "x-toolTitle": "Guthaben prüfen" } }, "/api/v2/uid-checks": { "post": { "tags": [ "public.companies.search" ], "summary": "Check an EU or XI VAT number", "description": "Prüft eine UID / Umsatzsteuer-Identifikationsnummer (VAT number) aus der EU oder Nordirland über VIES. Use check_uid for validity, not company search or resolve_companies. Returns verification with status valid or invalid, source and original verifiedAt; definitive results are reused for five minutes. Company matching is independent: no match does not mean invalid. Technical failures return an error, never invalid or a historical result as current. Uses the regular basic credit rate, including cached results; no confirmation required. Costs one credit for keys; sessions follow regular session pricing. Responses are private, no-store. Optional Idempotency-Key replays the original result for 24 hours; use a new key for a new check.", "operationId": "checkUid", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key retained for 24 hours. Replays are free; use a new key for a new check.", "schema": { "type": "string" }, "example": "uid-check-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckUidRequest" }, "example": { "uid": "ATU14490102" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CheckUidRequest" } } }, "required": true }, "responses": { "200": { "description": "Definitive VIES verification and independent company match.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckUidResponse" }, "example": { "verification": { "uid": "ATU14490102", "status": "valid", "source": "vies", "verifiedAt": "2026-10-21T12:00:00Z", "requestDate": "2026-10-21T00:00:00Z" }, "cached": false, "companyMatch": { "status": "unmatched" } } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "503": { "description": "Verification is unavailable; no current validity result. Retry later.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "check_uid", "x-toolTitle": "UID prüfen" } }, "/api/v2/people": { "get": { "tags": [ "public.people" ], "summary": "List people", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPeople", "parameters": [ { "name": "q", "in": "query", "description": "Case-insensitive label or path text.", "schema": { "type": "string" }, "example": "Muster" }, { "name": "function", "in": "query", "description": "Function code or German label (including singular or plural role labels) from GET /api/v2/catalogs/functions; filters people holding that function, case-insensitively.", "schema": { "type": "string" }, "example": "GF" }, { "name": "company", "in": "query", "description": "Company Firmenakte-ID, scheme:value register alias or bare Firmenbuchnummer; filters people with a function at that company.", "schema": { "type": "string" }, "example": "fnr:246552b" }, { "name": "place", "in": "query", "description": "Residence city text; matches residence.city exactly, not the company's seat. Residence may be unknown.", "schema": { "type": "string" }, "example": "Wien" }, { "name": "limit", "in": "query", "description": "Page size, default 25, minimum 1, maximum 100.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Page size, default 25, minimum 1, maximum 100.", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchPage" }, "example": { "items": [ { "id": "P-MG9X-V15A", "name": { "first": "Lena", "last": "Muster" }, "functionCount": 0, "functions": [] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_people", "x-toolTitle": "Personen auflisten" } }, "/api/v2/people/search": { "post": { "tags": [ "public.people" ], "summary": "Search people", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "searchPeople", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchRequest" }, "example": { "where": { "field": "functionCount", "op": "gte", "value": 3 }, "limit": 25 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchPage" }, "example": { "items": [ { "id": "P-MG9X-V15A", "name": { "first": "Lena", "last": "Muster" }, "functionCount": 0, "functions": [] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_people", "x-toolTitle": "Personen suchen" } }, "/api/v2/people/names": { "get": { "tags": [ "public.people" ], "summary": "List person names", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPersonNames", "parameters": [ { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 5000. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPersonNameEntry" }, "example": { "items": [ { "id": "P-MG9X-V15A", "name": "Lena Muster" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_person_names", "x-toolTitle": "Personennamen lesen" } }, "/api/v2/people/{id}": { "get": { "tags": [ "public.people" ], "summary": "Get a person", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "getPerson", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "include", "in": "query", "description": "Comma-separated functions, licenses, notices, registrations or changes; embeds the first 25 entries of each selected collection with its continuation cursor.", "schema": { "type": "string" }, "example": "functions,licenses,notices,registrations" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonResponse" }, "example": { "id": "P-MG9X-V15A", "type": "person", "name": { "first": "Lena", "last": "Muster" }, "identifiers": [], "formerIds": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "get_person", "x-toolTitle": "Person lesen" } }, "/api/v2/people/{id}/functions": { "get": { "tags": [ "public.people" ], "summary": "List person functions", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPersonFunctions", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "true returns only currently held functions; false or omitted includes historical functions too.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPersonFunction" }, "example": { "items": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_person_functions", "x-toolTitle": "Funktionen einer Person lesen" } }, "/api/v2/people/{id}/licenses": { "get": { "tags": [ "public.people" ], "summary": "List person licenses", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPersonLicenses", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "true or false; accepted for collection paging but does not filter this collection.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPersonLicense" }, "example": { "items": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_person_licenses", "x-toolTitle": "Gewerbe einer Person lesen" } }, "/api/v2/people/{id}/notices": { "get": { "tags": [ "public.people" ], "summary": "List person notices", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPersonNotices", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "true or false; accepted for collection paging but does not filter this collection.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" }, "example": { "items": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_person_notices", "x-toolTitle": "Veröffentlichungen einer Person lesen" } }, "/api/v2/people/{id}/registrations": { "get": { "tags": [ "public.people" ], "summary": "List professional registrations", "description": "Read public person data. Birth dates, birth years and ages are never exposed. Collections use keyset cursors expiring after 24 hours. Includes embed the first 25 and continue on their own path. Key or session required; ETag and private, no-cache. Costs one credit for keys, except the free names index.", "operationId": "listPersonRegistrations", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "true or false; accepted for collection paging but does not filter this collection.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPersonRegistration" }, "example": { "items": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_person_registrations", "x-toolTitle": "Registereinträge einer Person lesen" } }, "/api/v2/companies/{id}": { "get": { "tags": [ "public.companies.profile" ], "summary": "Get a company", "description": "Read a company by Firmenakte-ID or register alias. Aliases and merged identities resolve without redirects. Costs 1 credit; a conditional 304 is free. Dashboard sessions retain their existing price.", "operationId": "getCompany", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "include", "in": "query", "description": "Comma-separated accounts, people, licenses, funding, notices, documents, filings, addresses, industries and changes. Each embeds its first 25 entries; nextCursor continues on the collection's own path.", "schema": { "type": "string" }, "example": "accounts,people" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" }, "example": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH", "status": "active", "identifiers": [ { "scheme": "fnr", "value": "56247t" } ], "formerIds": [], "websites": [], "insolvency": { "status": "none", "sources": [] }, "flags": { "hasNotice": false, "isShamCompany": false } } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "get_company", "x-toolTitle": "Firmenprofil lesen" } }, "/api/v2/entities/{id}": { "get": { "tags": [ "public.search" ], "summary": "Get an entity", "description": "Read a company or person by Firmenakte-ID or register alias. A person answer carries no birth date, birth year or age. Costs 1 credit; a conditional 304 is free.", "operationId": "getEntity", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityResponse" }, "example": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH", "status": "active", "identifiers": [ { "scheme": "fnr", "value": "56247t" } ], "formerIds": [], "websites": [], "insolvency": { "status": "none", "sources": [] }, "flags": { "hasNotice": false, "isShamCompany": false } } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "get_entity", "x-toolTitle": "Registereintrag lesen" } }, "/api/v2/companies/search": { "post": { "tags": [ "public.companies.search" ], "summary": "Search companies", "description": "Search companies using a nested filter tree. Keyset cursors bind filter and sort and expire after 24 hours. Costs 1 credit, including cache hits. Use limit 0 for a count; limits above 100 are clamped.", "operationId": "searchCompanies", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchRequest" }, "example": { "where": { "field": "figures.revenue", "op": "gte", "value": 1000000 }, "sort": { "by": "figures.revenue", "direction": "desc" }, "limit": 25 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchPage" }, "example": { "items": [ { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH", "status": "active", "identifiers": [ { "scheme": "fnr", "value": "56247t" } ], "insolvency": { "status": "absent" }, "flags": { "hasNotice": false, "isShamCompany": false }, "figures": { "year": 2025, "currency": "EUR", "revenue": 1000000 } } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_companies", "x-toolTitle": "Firmen suchen" } }, "/api/v2/companies": { "get": { "tags": [ "public.companies.search" ], "summary": "List companies", "description": "The same operation as POST companies/search with q, place, status, legalForm, industry, trade and court as query parameters. No where or figures query parameters. Sort -revenue means descending figures.revenue. Keyset cursors bind filter and sort. Costs one credit for keys, including cache hits; conditional 304 is free.", "operationId": "listCompanies", "parameters": [ { "name": "q", "in": "query", "description": "Case-insensitive label or path text.", "schema": { "type": "string" }, "example": "umsatz" }, { "name": "place", "in": "query", "description": "Place code, label, slug or alias from GET /api/v2/places; filters company seats. Ambiguous matches must be narrowed.", "schema": { "type": "string" }, "example": "Graz" }, { "name": "status", "in": "query", "description": "active or inactive; filters company register status.", "schema": { "type": "string" }, "example": "active" }, { "name": "legalForm", "in": "query", "description": "Legal-form codes, German labels or short labels (such as GmbH) from GET /api/v2/catalogs/legal-forms; repeated values are ORed and matches are case-insensitive.", "schema": { "maxItems": 1000, "type": "array", "items": { "type": "string" } }, "example": [ "GmbH" ] }, { "name": "industry", "in": "query", "description": "ÖNACE codes (including display and register codes), German labels or short labels from GET /api/v2/catalogs/oenace; repeated values are ORed and matches are case-insensitive.", "schema": { "maxItems": 1000, "type": "array", "items": { "type": "string" } }, "example": [ "Maschinenbau" ] }, { "name": "trade", "in": "query", "description": "Trade codes or German labels from GET /api/v2/catalogs/trades; repeated values are ORed and matches are case-insensitive.", "schema": { "maxItems": 1000, "type": "array", "items": { "type": "string" } }, "example": [ "Tischler" ] }, { "name": "court", "in": "query", "description": "Court codes or German labels from GET /api/v2/catalogs/courts; repeated values are ORed and matches are case-insensitive.", "schema": { "maxItems": 1000, "type": "array", "items": { "type": "string" } }, "example": [ "Landesgericht Graz" ] }, { "name": "sort", "in": "query", "description": "Sortable field path from GET /api/v2/catalogs/fields, or a key-figure code from GET /api/v2/catalogs/key-figures. Prefix - for descending order; defaults to name ascending.", "schema": { "type": "string" }, "example": "-revenue" }, { "name": "limit", "in": "query", "description": "Page size, default 25, minimum 1, maximum 100.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Page size, default 25, minimum 1, maximum 100.", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchPage" }, "example": { "items": [ { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH", "status": "active", "identifiers": [ { "scheme": "fnr", "value": "56247t" } ], "insolvency": { "status": "absent" }, "flags": { "hasNotice": false, "isShamCompany": false }, "figures": { "year": 2025, "currency": "EUR", "revenue": 1000000 } } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_companies", "x-toolTitle": "Firmen auflisten" } }, "/api/v2/companies/aggregate": { "post": { "tags": [ "public.companies.search" ], "summary": "Aggregate companies", "description": "Count the complete filtered company set. Omit groupBy and metrics, or use empty arrays, for total with groups: []. An empty request counts all visible companies. Optional grouping uses legalForm, industry, city, zip, state or court; each group includes total, ungrouped and buckets. Optional metrics sum, average, min or max a catalog key figure across the complete filter, with known/missing counts; latest figure dates may differ. excludeOwnFilter removes each dimension's filters for facet counts. Short fields compile into the same filter tree. Account filters return 422 and point to POST /me/search/aggregate. Costs one credit for keys.", "operationId": "aggregateCompanies", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyAggregateRequest" }, "example": { "industry": "Maschinenbau", "groupBy": [ "state" ], "top": 10, "excludeOwnFilter": true } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyAggregateResponse" }, "example": { "total": 1, "groups": [ { "groupBy": "state", "total": 1, "ungrouped": 0, "buckets": [ { "key": "Steiermark", "label": "Steiermark", "count": 1 } ] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "aggregate_companies", "x-toolTitle": "Firmen zählen und gruppieren" } }, "/api/v2/companies/top": { "post": { "tags": [ "public.companies.search" ], "summary": "Find the leading company per place", "description": "Find the leader per state or city by a figures field, with a map location and the metric year. City groups are capped to the sixteen largest by company count. Short fields compile into the same filter tree. Account filters return 422 and point to POST /me/search/aggregate. Costs one credit for keys.", "operationId": "topCompanies", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTopRequest" }, "example": { "place": "Oberösterreich", "per": "state", "by": "figures.totalAssets" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyTopItem" }, "example": { "items": [ { "group": { "key": "Steiermark", "label": "Steiermark" }, "company": { "id": "C-KX1V-B12Z", "name": "Red Bull GmbH", "location": { "lat": 47.79, "lng": 13.29 } }, "value": 1000000, "year": 2025 } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "top_companies", "x-toolTitle": "Größte Firma je Ort" } }, "/api/v2/catalogs/{name}": { "get": { "tags": [ "public.catalogs.vocabulary" ], "summary": "Get a catalog", "description": "Read legal-forms, oenace, trades, courts, functions, key-figures, registers, change-types or places. Every entry carries its parentCode, level, childCount and ancestor path; parent= reads one node's children and level= one level. refCount counts the visible companies under a value (current assignments for functions) as of the last refresh; static catalogues carry none. Without q, entries are ordered by refCount, then code. Register entries document field-detail coverage and unknown historical starts; change types carry German labels. Entries contain codes and German labels, never storage fields. Free for keys and sessions; supports ETag and free conditional 304. Cursor paging defaults to 25 and clamps to 100.", "operationId": "getCatalog", "parameters": [ { "name": "name", "in": "path", "description": "legal-forms, oenace, trades, courts, functions, key-figures, registers, change-types or places.", "required": true, "schema": { "type": "string" }, "example": "key-figures" }, { "name": "q", "in": "query", "description": "Case-insensitive label or path text.", "schema": { "type": "string" }, "example": "umsatz" }, { "name": "limit", "in": "query", "description": "Page size; default 100 for key-figures, 25 for other catalogues; maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "parent", "in": "query", "description": "A catalog code; returns only its direct children.", "schema": { "type": "string" }, "example": "C" }, { "name": "level", "in": "query", "description": "Hierarchy level; 1 is the top level.", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCatalogEntry" }, "example": { "items": [ { "code": "revenue", "label": "Umsatzerlöse", "statement": "incomeStatement", "unit": "EUR", "level": 1, "childCount": 0 } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_catalog", "x-toolTitle": "Katalog nachschlagen" } }, "/api/v2/places": { "get": { "tags": [ "public.catalogs.places" ], "summary": "Search places", "description": "Search state, municipality, city and zip vocabulary by code, label or slug. States, municipalities and Austrian zip codes carry their place in the places catalogue (parentCode, level, childCount, path); every entry carries its company count as refCount. Free for keys and sessions; supports ETag and free conditional 304. Cursor paging defaults to 25 and clamps to 100.", "operationId": "searchPlaces", "parameters": [ { "name": "q", "in": "query", "description": "Case-insensitive label or path text.", "schema": { "type": "string" }, "example": "Graz" }, { "name": "type", "in": "query", "description": "state, municipality, district, city or zip; restricts the place vocabulary to that type. Omit to search states, municipalities, cities and PLZ; Wien's Bezirke are listed only for district.", "schema": { "type": "string" }, "example": "municipality" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfPlaceEntry" }, "example": { "items": [ { "type": "municipality", "code": "60101", "label": "Graz", "state": "Steiermark", "zip": [ "8010" ], "slug": "graz", "companyCount": 28417, "parentCode": "Steiermark", "level": 2, "childCount": 16, "refCount": 28417, "path": [ { "code": "Steiermark", "label": "Steiermark" } ] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "search_places", "x-toolTitle": "Orte suchen" } }, "/api/v2/catalogs/fields": { "get": { "tags": [ "public.catalogs.fields" ], "summary": "List the field catalog", "description": "Returns a page of field definitions with German labels, groups, capabilities, operators and options. Use filterable=true and scope=public to discover fields for search_companies, aggregate_companies and search_people; display-only columns have filterable=false. Browse group=figures for financial metrics or q=seat. for company location fields. Select subject person for person filters. q searches field metadata, not company names or location values; use search_places for places and get_catalog for industry or other catalog values. Account fields describe templates, not workspace definitions. Free for keys and sessions; supports ETag and conditional 304.", "operationId": "listFieldCatalog", "parameters": [ { "name": "subject", "in": "query", "description": "Field subject: company (default) or person.", "schema": { "type": "string" }, "example": "company" }, { "name": "q", "in": "query", "description": "Optional field path, reference, alias, German label or group search, at most 200 characters. Includes nested relation fields; ignores case and accents. For field families use seat. or figures.; for values use search_places or get_catalog instead.", "schema": { "type": "string" }, "example": "umsatz" }, { "name": "register", "in": "query", "description": "Optional register filter matching a field's register, for example firmenbuch or gisa.", "schema": { "type": "string" }, "example": "firmenbuch" }, { "name": "scope", "in": "query", "description": "Optional scope: public or account. Use public for public search tools; account fields describe templates, not workspace definitions.", "schema": { "type": "string" }, "example": "public" }, { "name": "limit", "in": "query", "description": "Page size, default 25, maximum 100. A value of 0 returns only the total.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque nextCursor from the previous page. Keep subject, q, register, scope, filterable and group unchanged; expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "filterable", "in": "query", "description": "true returns only fields accepted in filters; false returns only display fields; omit to return both. A relation's quantifiers and subfields describe its predicate.", "schema": { "type": "boolean" }, "example": true }, { "name": "group", "in": "query", "description": "Optional exact group.code from this subject's field metadata: basics, location, activity, status, people, figures or account. Groups describe the field's meaning, independently of its value type.", "schema": { "type": "string" }, "example": "figures" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfFieldDefinition" }, "example": { "items": [ { "path": "figures.revenue", "label": "Umsatzerlöse", "type": "number", "scope": "public", "ops": [ "eq", "gt", "exists" ], "filterable": true, "sortable": true, "columnable": true, "register": "firmenbuch", "appliesTo": [ "company" ], "yearBound": true } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_field_catalog", "x-toolTitle": "Filterfelder auflisten" } }, "/api/v2/companies/{id}/accounts": { "get": { "tags": [ "public.companies.finances" ], "summary": "List company accounts", "description": "Read company accounts. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=accounts on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyAccounts", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyAccount" }, "example": { "items": [ { "year": 2025, "documentDate": "2025-12-31", "currency": "EUR", "employees": 5, "figures": { "totalAssets": 100000 }, "document": { "key": "fixture-accounts" } } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_accounts", "x-toolTitle": "Jahresabschlüsse einer Firma" } }, "/api/v2/companies/{id}/people": { "get": { "tags": [ "public.companies.profile" ], "summary": "List company people", "description": "Functions that have not ended come first, on the Vienna calendar day. current=true returns functions that have started and not ended (inclusive dates; absent bounds are open). Firmenbuch and EVI relationships reconcile distinct roles and subscribed capital, supported sharePercent and source-owned evidence. Unknown percentages are omitted. Cursor paging defaults to 25, clamps to 100 and continues include=people. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyPeople", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyPerson" }, "example": { "items": [ { "person": { "id": "P-7K3M-QX91", "name": "Gerhard Fixture" }, "function": { "code": "GS", "label": "Gesellschafter" }, "source": "evi", "sharePercent": 66.67, "evidence": [ { "source": "evi", "sourceUrl": "https://www.evi.gv.at/b/fixture", "observedAt": "2026-09-01T12:00:00Z", "entryDate": "2026-08-31" } ] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_people", "x-toolTitle": "Personen einer Firma lesen" } }, "/api/v2/companies/{id}/licenses": { "get": { "tags": [ "public.companies.register" ], "summary": "List company licenses", "description": "Read company licenses. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=licenses on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyLicenses", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyLicense" }, "example": { "items": [ { "gisaNumber": "12345678", "trade": { "key": 500267, "label": "Handelsgewerbe" }, "holder": { "id": "C-KX1V-B12Z", "name": "Red Bull GmbH" }, "source": "gisa", "description": "Handelsgewerbe" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_licenses", "x-toolTitle": "Gewerbeberechtigungen lesen" } }, "/api/v2/companies/{id}/notices": { "get": { "tags": [ "public.companies.register" ], "summary": "List company notices", "description": "Read company notices. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=notices on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyNotices", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" }, "example": { "items": [ { "kind": "sham-company", "publishedDate": "2026-09-01", "source": "bmf" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_notices", "x-toolTitle": "Veröffentlichungen lesen" } }, "/api/v2/companies/{id}/documents": { "get": { "tags": [ "public.companies.register" ], "summary": "List company documents", "description": "Read company documents. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=documents on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyDocuments", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyDocument" }, "example": { "items": [ { "key": "fixture-accounts", "documentDate": "2025-12-31", "format": "xml", "hasParsedAccounts": true } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_documents", "x-toolTitle": "Dokumente auflisten" } }, "/api/v2/companies/{id}/filings": { "get": { "tags": [ "public.companies.register" ], "summary": "List company filings", "description": "Read company filings. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=filings on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyFilings", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyFiling" }, "example": { "items": [ { "number": "001", "executionDate": "2026-09-01", "changes": [ { "type": "name", "text": "Red Bull GmbH" } ], "source": "firmenbuch" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_filings", "x-toolTitle": "Firmenbucheinträge lesen" } }, "/api/v2/companies/{id}/addresses": { "get": { "tags": [ "public.companies.profile" ], "summary": "List company addresses", "description": "Read company addresses. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=addresses on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyAddresses", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyAddress" }, "example": { "items": [ { "kind": "seat", "zip": "5020", "city": "Salzburg", "current": true, "source": "firmenbuch" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_addresses", "x-toolTitle": "Firmenadressen lesen" } }, "/api/v2/companies/{id}/industries": { "get": { "tags": [ "public.companies.profile" ], "summary": "List company industries", "description": "Read company industries. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=industries on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyIndustries", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyIndustryAssignment" }, "example": { "items": [ { "oenace": "C10", "label": "Herstellung von Nahrungsmitteln", "main": true, "source": "statistik-austria" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_industries", "x-toolTitle": "Branchen einer Firma lesen" } }, "/api/v2/companies/{id}/funding": { "get": { "tags": [ "public.companies.finances" ], "summary": "List company funding", "description": "Read company funding. Cursor paging defaults to 25 and clamps to 100. nextCursor continues include=funding on this path. Cursors bind the company and filters, expire after 24 hours, and reject changed filters. Costs one credit for keys; conditional 304 is free.", "operationId": "listCompanyFunding", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyFundingPage" }, "example": { "items": [ { "year": 2025, "measure": "Forschung", "amount": 1000, "currency": "EUR", "source": "transparenzportal", "asOf": "2026-01-01" } ], "summary": { "count": 1, "sum": 1000, "years": [ 2025 ] } } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_funding", "x-toolTitle": "Förderungen lesen" } }, "/api/v2/companies/names": { "get": { "tags": [ "public.companies.search" ], "summary": "List company names", "description": "Authenticated, free index of canonical company IDs, Firmenbuchnummern and names. Keyset paging defaults to 25 and clamps to 5000; supports ETag and free conditional 304.", "operationId": "listCompanyNames", "parameters": [ { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 5000. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfCompanyNameEntry" }, "example": { "items": [ { "id": "C-KX1V-B12Z", "fnr": "56247t", "name": "Red Bull GmbH" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "list_company_names", "x-toolTitle": "Firmennamen lesen" } }, "/api/v2/companies/batch-get": { "post": { "tags": [ "public.companies.search" ], "summary": "Get a batch of companies", "description": "Read up to 100 company IDs or aliases in request order. Each ok or merged item costs one credit; ambiguous and notFound items are free. Sessions retain their dashboard price.", "operationId": "batchGetCompanies", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBatchRequest" }, "example": { "ids": [ "fnr:56247t" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBatchResponse" }, "example": { "items": [ { "requested": "fnr:999999z", "status": "notFound", "candidates": [] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1, "per": "ok or merged item" }, "x-exposure": "customer", "x-toolName": "batch_get_companies", "x-toolTitle": "Firmenprofile gemeinsam lesen" } }, "/api/v2/companies/resolve": { "post": { "tags": [ "public.companies.search" ], "summary": "Resolve company names", "description": "Resolve up to 100 company/person inputs with name, address, country, UID, registry, fnr or akteId. Identifiers and unique exact names match automatically; search candidates are always ambiguous, never auto-linked. Foreign companies and people without an akteId are unmatched. minConfidence is retained for compatibility but does not auto-link fuzzy candidates. CSV import and form suggestions use this same operation. Costs one credit for keys.", "operationId": "resolveCompanies", "parameters": [ { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResolveRequest" }, "example": { "items": [ { "ref": "row-1", "name": "Pankl Racing Systems AG", "city": "Kapfenberg", "country": "AT" } ], "minConfidence": 0.8 } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResolveResponse" }, "example": { "items": [ { "ref": "row-1", "status": "matched", "id": "C-KX1V-B12Z", "matchedName": "Pankl Racing Systems AG", "confidence": 1, "method": "name", "candidates": [ { "id": "C-KX1V-B12Z", "name": "Pankl Racing Systems AG", "confidence": 1 } ] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "resolve_companies", "x-toolTitle": "Firmen zuordnen" } }, "/api/v2/companies/{id}/network": { "get": { "tags": [ "public.companies.profile" ], "summary": "Get a company's network", "description": "The shared Firmenbuch and EVI network, with canonical company/person node IDs and assignment, ownership and address edges. Depth 1 matches the existing graph, depths 2 and 3 read further layers, preserving node limits. Includes supported shares and provenance. Costs three credits for keys; conditional 304 is free.", "operationId": "getCompanyNetwork", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "depth", "in": "query", "description": "Company neighbourhood depth, 1 to 3; default 1.", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNetworkResponse" }, "example": { "depth": 1, "nodes": [ { "id": "C-KX1V-B12Z", "type": "company", "label": "Red Bull GmbH", "central": true, "hasMore": false } ], "edges": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "expensive", "cost": 3 }, "x-exposure": "customer", "x-toolName": "get_company_network", "x-toolTitle": "Netzwerk einer Firma" } }, "/api/v2/companies/{id}/similar": { "get": { "tags": [ "public.companies.profile" ], "summary": "List similar companies", "description": "The bounded similarity neighbourhood from the existing network, industry and location matcher. Cursor-paged, costs three credits for keys; conditional 304 is free.", "operationId": "listSimilarCompanies", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "limit", "in": "query", "description": "Page size; default 25, maximum 100. Zero returns the count.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "current", "in": "query", "description": "Only current functions when true.", "schema": { "type": "boolean" }, "example": true }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfSimilarCompany" }, "example": { "items": [ { "id": "C-KX1V-B12Z", "name": "Red Bull GmbH", "reasons": [] } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "expensive", "cost": 3 }, "x-exposure": "customer", "x-toolName": "list_similar_companies", "x-toolTitle": "Ähnliche Firmen finden" } }, "/api/v2/addresses/status": { "get": { "tags": [ "public.catalogs.places" ], "summary": "Read address snapshot status", "description": "Read snapshot date, availability and refresh health. Validation covers Austrian snapshot base addresses; worldwide address storage remains available independently. Free for keys and sessions. Responses are private, no-store.", "operationId": "getAddressStatus", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "address-read-1" } ], "responses": { "200": { "description": "Read address snapshot status.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpdateStatus" }, "example": { "status": "active", "sourceDate": "2026-10-01", "importedAt": "2026-10-21T12:00:00Z", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "lastCheck": "2026-10-21T12:00:00Z", "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:1" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_address_status", "x-toolTitle": "Adressdatenstand lesen" } }, "/api/v2/addresses": { "get": { "tags": [ "public.catalogs.places" ], "summary": "Search Austrian reference addresses", "description": "Search the Austrian BEV snapshot with bounded autocomplete results. Suggestions are not confirmed matches. Returns stable A/G identities, source date and attribution; never searches private inputs. Costs one credit for keys; sessions follow regular session pricing. Supports ETag and free conditional 304 responses.", "operationId": "searchAddresses", "parameters": [ { "name": "q", "in": "query", "description": "Address search text, 2–200 characters.", "schema": { "maxLength": 200, "type": "string", "description": "Address search text, 2–200 characters." }, "example": "Hauptgasse 4" }, { "name": "limit", "in": "query", "description": "Page size, 1–100; default 25. Zero is not supported.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque continuation from nextCursor. Bound to the query, geography, postal code and active snapshot; expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "geographyId", "in": "query", "description": "Optional G-ID restricting geography.", "schema": { "type": "string", "description": "Optional G-ID restricting geography." }, "example": "G-1234-567G" }, { "name": "zip", "in": "query", "description": "Optional postal code.", "schema": { "maxLength": 40, "type": "string", "description": "Optional postal code." }, "example": "7000" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "address-read-1" } ], "responses": { "200": { "description": "Search Austrian reference addresses.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfReferenceAddressResponse" }, "example": { "items": [ { "id": "A-1234-5673", "bevCode": "1234567", "street": "Hauptgasse", "houseNumber": "4", "zip": "7000", "city": "Eisenstadt", "country": "AT", "active": true, "geography": [ { "id": "G-1234-567G", "type": "municipality", "code": "10101", "label": "Eisenstadt" } ], "coordinates": { "lat": 47.845, "lng": 16.523, "source": "bev", "transformationAccuracyMetres": 1.5, "determination": "building", "sourceMethod": "BEV" }, "provenance": { "source": "bev", "sourceDate": "2026-10-01", "importedAt": "2026-10-21T12:00:00Z", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "license": "https://creativecommons.org/licenses/by/4.0/", "attribution": "© Österreichisches Adressregister, Stichtagsdaten vom 01.10.2026", "processing": "Firmenakte: search normalization and EPSG 1618 coordinate transformation; no delivery, occupancy or unit verification." } } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search_addresses", "x-toolTitle": "Adressen suchen" } }, "/api/v2/addresses/validate": { "post": { "tags": [ "public.catalogs.places" ], "summary": "Check an address against the Austrian snapshot", "description": "Compare one address with the active Austrian BEV snapshot without storing it. Returns exact, normalized, ambiguous, not_found, unsupported_country or unavailable. A match confirms only the snapshot base address; units, deliverability, people and company occupancy remain unverified. International addresses may still be stored in own entries. This read requires no confirmation. Costs one credit for keys; sessions follow regular session pricing. Responses are private, no-store.", "operationId": "checkAddress", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "address-read-1" } ], "requestBody": { "description": "Country is required. Supply full address text or structured street fields. Matching needs a base house number, postal code and city; units remain unverified. The input is never saved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationRequest" }, "example": { "country": "AT", "street": "Hauptgasse", "houseNumber": "4", "zip": "7000", "city": "Eisenstadt", "unit": "Top 2" } } }, "required": true }, "responses": { "200": { "description": "Check an address against the Austrian snapshot.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" }, "example": { "status": "exact", "address": { "id": "A-1234-5673", "bevCode": "1234567", "street": "Hauptgasse", "houseNumber": "4", "zip": "7000", "city": "Eisenstadt", "country": "AT", "active": true, "geography": [ { "id": "G-1234-567G", "type": "municipality", "code": "10101", "label": "Eisenstadt" } ], "coordinates": { "lat": 47.845, "lng": 16.523, "source": "bev", "transformationAccuracyMetres": 1.5, "determination": "building", "sourceMethod": "BEV" }, "provenance": { "source": "bev", "sourceDate": "2026-10-01", "importedAt": "2026-10-21T12:00:00Z", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "license": "https://creativecommons.org/licenses/by/4.0/", "attribution": "© Österreichisches Adressregister, Stichtagsdaten vom 01.10.2026", "processing": "Firmenakte: search normalization and EPSG 1618 coordinate transformation; no delivery, occupancy or unit verification." } }, "candidates": [], "changes": [], "unitStatus": "unverified", "coverage": "AT snapshot base address", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "check_address", "x-toolTitle": "Adresse prüfen" } }, "/api/v2/addresses/{id}": { "get": { "tags": [ "public.catalogs.places" ], "summary": "Get a reference address", "description": "Resolve a stable A Firmenakte-ID, including inactive historical addresses. Returns BEV provenance and source date, geographic identities and transformed coordinates without any reverse company or private-entry relationship. Costs one credit for keys; sessions follow regular session pricing. Supports ETag and free conditional 304 responses.", "operationId": "getAddress", "parameters": [ { "name": "id", "in": "path", "description": "Stable A Firmenakte-ID (compact or hyphenated, including merged IDs), or bev: alias. Resolves published current or historical addresses.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "A-1234-5673" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "address-read-1" } ], "responses": { "200": { "description": "Get a reference address.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceAddressResponse" }, "example": { "id": "A-1234-5673", "bevCode": "1234567", "street": "Hauptgasse", "houseNumber": "4", "zip": "7000", "city": "Eisenstadt", "country": "AT", "active": true, "geography": [ { "id": "G-1234-567G", "type": "municipality", "code": "10101", "label": "Eisenstadt" } ], "coordinates": { "lat": 47.845, "lng": 16.523, "source": "bev", "transformationAccuracyMetres": 1.5, "determination": "building", "sourceMethod": "BEV" }, "provenance": { "source": "bev", "sourceDate": "2026-10-01", "importedAt": "2026-10-21T12:00:00Z", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "license": "https://creativecommons.org/licenses/by/4.0/", "attribution": "© Österreichisches Adressregister, Stichtagsdaten vom 01.10.2026", "processing": "Firmenakte: search normalization and EPSG 1618 coordinate transformation; no delivery, occupancy or unit verification." } } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "get_address", "x-toolTitle": "Adresse auflösen" } }, "/api/v2/places/{id}": { "get": { "tags": [ "public.catalogs.places" ], "summary": "Get a geographic place", "description": "Resolve a stable G Firmenakte-ID or source alias, including retired geography. Returns the typed source code, snapshot date and all parent identities. Postal coverage can have several municipalities; cities, municipalities and districts are distinct types. Free for keys and sessions. Supports ETag and free conditional 304 responses.", "operationId": "getPlace", "parameters": [ { "name": "id", "in": "path", "description": "Stable G Firmenakte-ID (compact or hyphenated, including merged IDs), or geographic source alias such as gkz:10101. Resolves published current or retired geography.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "G-1234-567G" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" } ], "responses": { "200": { "description": "Get a geographic place.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicPlaceResponse" }, "example": { "id": "G-1234-567G", "type": "municipality", "code": "10101", "name": "Eisenstadt", "active": true, "sourceDate": "2026-10-01", "datasetVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "parents": [] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "free", "cost": 0 }, "x-exposure": "customer", "x-toolName": "get_place", "x-toolTitle": "Geografischen Ort auflösen" } }, "/api/v2/documents/{key}/content": { "get": { "tags": [ "public.companies.register" ], "summary": "Download a Firmenbuch document", "description": "Download register file content without workspace data. Firmenbuch documents are PDF or XML; GISA extracts are signed German PDFs. Costs the expensive-class price (3 credits); failed reads and matching conditional 304s are free. ETag and private, no-cache; errors remain problem JSON.", "operationId": "getDocumentContent", "parameters": [ { "name": "key", "in": "path", "description": "Resource key.", "required": true, "schema": { "type": "string" }, "example": "export_example" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" }, { "name": "If-None-Match", "in": "header", "description": "A matching ETag returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" }, "example": "Binary file content" }, "application/xml": { "schema": { "type": "string", "format": "binary" }, "example": "Binary file content" } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "expensive", "cost": 3 }, "x-exposure": "customer", "x-toolName": "get_document_content", "x-toolTitle": "Dokument herunterladen" } }, "/api/v2/licenses/{gisaNumber}/extract": { "get": { "tags": [ "public.companies.register" ], "summary": "Download a GISA extract", "description": "Download register file content without workspace data. Firmenbuch documents are PDF or XML; GISA extracts are signed German PDFs. Costs the expensive-class price (3 credits); failed reads and matching conditional 304s are free. ETag and private, no-cache; errors remain problem JSON.", "operationId": "getLicenseExtract", "parameters": [ { "name": "gisaNumber", "in": "path", "description": "Resource key.", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": "12345678" }, { "name": "historical", "in": "query", "description": "Resource key.", "schema": { "type": "boolean", "default": false }, "example": "export_example" }, { "name": "language", "in": "query", "description": "Resource key.", "schema": { "type": "string", "default": "de" }, "example": "export_example" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours.", "schema": { "type": "string" }, "example": "export-1" }, { "name": "If-None-Match", "in": "header", "description": "A matching ETag returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" }, "example": "Binary file content" } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "expensive", "cost": 3 }, "x-exposure": "customer", "x-toolName": "get_license_extract", "x-toolTitle": "Gewerbeauszug herunterladen" } }, "/api/v2/search": { "get": { "tags": [ "public.search" ], "summary": "Search companies and people", "description": "Rank companies and people together by where q sits in the name, then name length, companies before people, name and ID. Accepts types=company,person. Key or session required; one credit for keys, ETag and private, no-cache. No account data or search history is read or written. Cursors bind query and types and expire after 24 hours.", "operationId": "search", "parameters": [ { "name": "q", "in": "query", "description": "Case-insensitive label or path text.", "schema": { "type": "string" }, "example": "red bull" }, { "name": "types", "in": "query", "description": "Comma-separated company, person, or both; restricts the entity types searched. Defaults to company,person.", "schema": { "type": "string" }, "example": "company,person" }, { "name": "limit", "in": "query", "description": "Page size, default 25, minimum 1, maximum 100.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Page size, default 25, minimum 1, maximum 100.", "format": "int32" }, "example": 25 }, { "name": "cursor", "in": "query", "description": "Opaque cursor from the previous page. Expires after 24 hours.", "schema": { "type": "string" }, "example": "opaque-cursor" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchPage" }, "example": { "items": [ { "type": "company", "id": "C-KX1V-B12Z", "name": "Red Bull GmbH", "summary": "Fuschl am See" } ] } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "search", "x-toolTitle": "Firma oder Person suchen" } }, "/api/v2/changes": { "get": { "tags": [ "public.changes" ], "summary": "List all register changes", "description": "Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.", "operationId": "listChanges", "parameters": [ { "name": "after", "in": "query", "description": "Last processed sequence; never expires. Omit to start retained history.", "schema": { "type": "string" }, "example": "0" }, { "name": "register", "in": "query", "description": "Filter by source register.", "schema": { "type": "string" }, "example": "firmenbuch" }, { "name": "subject", "in": "query", "description": "company or person; defaults to company.", "schema": { "type": "string" }, "example": "fnr:246552b" }, { "name": "limit", "in": "query", "description": "Page size, 1 to 100; default 25.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "type", "in": "query", "description": "Exact change-type code from GET /api/v2/catalogs/change-types; returns only matching feed entries.", "schema": { "type": "string" }, "example": "company.officerAdded" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChangeEntry" }, "example": { "items": [ { "id": "chg_1", "sequence": 1, "register": "firmenbuch", "type": "company.filingAdded", "subject": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" }, "recordedAt": "2026-10-02T12:00:00Z", "summary": "Eine Firmenbucheintragung wurde veröffentlicht.", "detail": "partial", "fieldsChanged": [], "data": { "kind": "firmenbuch", "number": "1", "changes": [] } } ], "nextCursor": "1" } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_changes", "x-toolTitle": "Registeränderungen lesen" } }, "/api/v2/changes/{id}": { "get": { "tags": [ "public.changes" ], "summary": "Get a register change", "description": "Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.", "operationId": "getChange", "parameters": [ { "name": "id", "in": "path", "description": "Stable feed entry ID, for example chg_1.", "required": true, "schema": { "type": "string" }, "example": "chg_1" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEntry" }, "example": { "id": "chg_1", "sequence": 1, "register": "firmenbuch", "type": "company.filingAdded", "subject": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" }, "recordedAt": "2026-10-02T12:00:00Z", "summary": "Eine Firmenbucheintragung wurde veröffentlicht.", "detail": "partial", "fieldsChanged": [], "data": { "kind": "firmenbuch", "number": "1", "changes": [] } } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "get_change", "x-toolTitle": "Änderung lesen" } }, "/api/v2/companies/{id}/changes": { "get": { "tags": [ "public.changes" ], "summary": "List a company's register changes", "description": "Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.", "operationId": "listCompanyChanges", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "fnr:56247t" }, { "name": "after", "in": "query", "description": "Last processed sequence; never expires. Omit to start retained history.", "schema": { "type": "string" }, "example": "0" }, { "name": "register", "in": "query", "description": "Filter by source register.", "schema": { "type": "string" }, "example": "firmenbuch" }, { "name": "subject", "in": "query", "description": "company or person; defaults to company.", "schema": { "type": "string" }, "example": "fnr:246552b" }, { "name": "limit", "in": "query", "description": "Page size, 1 to 100; default 25.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "type", "in": "query", "description": "Exact change-type code from GET /api/v2/catalogs/change-types; returns only matching feed entries.", "schema": { "type": "string" }, "example": "company.officerAdded" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChangeEntry" }, "example": { "items": [ { "id": "chg_1", "sequence": 1, "register": "firmenbuch", "type": "company.filingAdded", "subject": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" }, "recordedAt": "2026-10-02T12:00:00Z", "summary": "Eine Firmenbucheintragung wurde veröffentlicht.", "detail": "partial", "fieldsChanged": [], "data": { "kind": "firmenbuch", "number": "1", "changes": [] } } ], "nextCursor": "1" } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_company_changes", "x-toolTitle": "Firmenänderungen lesen" } }, "/api/v2/people/{id}/changes": { "get": { "tags": [ "public.changes" ], "summary": "List a person's register changes", "description": "Commit-ordered durable feed. after is the last processed non-negative sequence and never expires. A transactional counter serializes allocation until commit; the safe horizon is its committed value visible to this read. Only entries at or below the horizon are served. Delivery is at least once: deduplicate on stable id. nextCursor advances through the horizon even if no entries match. Omit after to read retained history. Filters: register, type and subject ID or alias; person subjects also match referenced people. Detail is full, partial or none, with typed data per register. Key or session required, one credit for keys, ETag and private, no-cache.", "operationId": "listPersonChanges", "parameters": [ { "name": "id", "in": "path", "description": "Firmenakte-ID (compact or hyphenated, including merged IDs), scheme:value register alias, or a bare Firmenbuchnummer. Resolves to the canonical visible record without redirects.", "required": true, "schema": { "$ref": "#/components/schemas/AkteId" }, "example": "P-MG9X-V15A" }, { "name": "after", "in": "query", "description": "Last processed sequence; never expires. Omit to start retained history.", "schema": { "type": "string" }, "example": "0" }, { "name": "register", "in": "query", "description": "Filter by source register.", "schema": { "type": "string" }, "example": "firmenbuch" }, { "name": "subject", "in": "query", "description": "company or person; defaults to company.", "schema": { "type": "string" }, "example": "fnr:246552b" }, { "name": "limit", "in": "query", "description": "Page size, 1 to 100; default 25.", "schema": { "type": "integer", "format": "int32" }, "example": 25 }, { "name": "type", "in": "query", "description": "Exact change-type code from GET /api/v2/catalogs/change-types; returns only matching feed entries.", "schema": { "type": "string" }, "example": "company.officerAdded" }, { "name": "If-None-Match", "in": "header", "description": "ETag from a previous read. A match returns a free 304.", "schema": { "type": "string" }, "example": "\"previous-etag\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional replay key, retained for 24 hours. Replays are free.", "schema": { "type": "string" }, "example": "company-read-1" } ], "responses": { "200": { "description": "OK", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } }, "ETag": { "description": "Validator for conditional reads.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPageOfChangeEntry" }, "example": { "items": [ { "id": "chg_1", "sequence": 1, "register": "firmenbuch", "type": "company.filingAdded", "subject": { "id": "C-KX1V-B12Z", "type": "company", "name": "Red Bull GmbH" }, "recordedAt": "2026-10-02T12:00:00Z", "summary": "Eine Firmenbucheintragung wurde veröffentlicht.", "detail": "partial", "fieldsChanged": [], "data": { "kind": "firmenbuch", "number": "1", "changes": [] } } ], "nextCursor": "1" } } } }, "304": { "description": "Unchanged; no credits charged.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } } }, "400": { "description": "Malformed request, or a cursor from another request.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "401": { "description": "No valid API key or session.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "402": { "description": "Not enough credits for this call.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "404": { "description": "Not found, or it belongs to another workspace.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "409": { "description": "Conflict with the current state; `code` says which.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "410": { "description": "Erased or expired.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Validation failed; `errors[]` names each parameter or JSON pointer.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Too many requests; retry after `Retry-After`.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "500": { "description": "Internal error; quote `requestId` to support.", "headers": { "Credits-Cost": { "description": "Credits charged for this response.", "schema": { "type": "integer" } }, "Credits-Remaining": { "description": "Available credits after the request.", "schema": { "type": "integer", "format": "int64" } } }, "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "x-group": "public", "x-credits": { "class": "basic", "cost": 1 }, "x-exposure": "customer", "x-toolName": "list_person_changes", "x-toolTitle": "Personenänderungen lesen" } } }, "components": { "schemas": { "AccountAuthor": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AccountDocument": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string" } } }, "AccountLiability": { "required": [ "label", "amount", "after" ], "type": "object", "properties": { "label": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "after": { "type": "string" } } }, "AccountSubject": { "required": [ "id", "name", "kind" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "kind": { "type": "string" }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "entryId": { "type": [ "null", "string" ], "default": null } } }, "AddressCoordinatesResponse": { "required": [ "lat", "lng", "source", "transformationAccuracyMetres", "determination", "sourceMethod" ], "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" }, "source": { "type": "string" }, "transformationAccuracyMetres": { "type": "number", "format": "double" }, "determination": { "type": "string" }, "sourceMethod": { "type": "string" } } }, "AddressGeographyReference": { "required": [ "id", "type", "code", "label" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string" }, "label": { "type": "string" } } }, "AddressProvenance": { "required": [ "source", "sourceDate", "importedAt", "datasetVersion", "license", "attribution", "processing" ], "type": "object", "properties": { "source": { "type": "string" }, "sourceDate": { "type": "string", "format": "date" }, "importedAt": { "type": "string", "format": "date-time" }, "datasetVersion": { "type": "string" }, "license": { "type": "string" }, "attribution": { "type": "string" }, "processing": { "type": "string" } } }, "AddressUpdateStatus": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" }, "sourceDate": { "type": [ "null", "string" ], "format": "date" }, "importedAt": { "type": [ "null", "string" ], "format": "date-time" }, "datasetVersion": { "type": [ "null", "string" ] }, "lastCheck": { "type": [ "null", "string" ], "format": "date-time" }, "lastError": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "string" ], "default": null } } }, "AddressValidationRequest": { "required": [ "country" ], "type": "object", "properties": { "country": { "maxLength": 100, "type": "string", "description": "Country code/name; required." }, "text": { "maxLength": 500, "type": [ "null", "string" ], "description": "Full address; or supply street fields.", "default": null }, "street": { "maxLength": 200, "type": [ "null", "string" ], "description": "Street.", "default": null }, "houseNumber": { "maxLength": 100, "type": [ "null", "string" ], "description": "Base house number.", "default": null }, "zip": { "maxLength": 40, "type": [ "null", "string" ], "description": "Postal code.", "default": null }, "city": { "maxLength": 200, "type": [ "null", "string" ], "description": "City.", "default": null }, "unit": { "maxLength": 100, "type": [ "null", "string" ], "description": "Unit; never BEV-verified.", "default": null } }, "additionalProperties": false }, "AddressValidationResponse": { "required": [ "status", "candidates", "changes", "unitStatus", "coverage" ], "type": "object", "properties": { "status": { "type": "string" }, "address": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ReferenceAddressResponse" } ] }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceAddressResponse" } }, "changes": { "type": "array", "items": { "type": "string" } }, "unitStatus": { "type": "string" }, "coverage": { "type": "string" }, "datasetVersion": { "type": [ "null", "string" ] } } }, "AkteId": { "examples": [ "fnr:56247t" ], "type": "string", "description": "A Firmenakte ID or register alias, for example fnr:56247t, resolved to the canonical record." }, "CapturedSelectionDto": { "required": [ "selection" ], "type": "object", "properties": { "selection": { "$ref": "#/components/schemas/SelectionHandle" }, "preview": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StoredResultReference" } ] } } }, "CaptureSelectionRequest": { "type": "object", "oneOf": [ { "required": [ "companies" ] }, { "required": [ "people" ] }, { "required": [ "entries" ] } ], "properties": { "companies": { "description": "Company search to freeze; no cursor. Supply exactly one of companies, people or entries.", "$ref": "#/components/schemas/CompanySearchRequest" }, "people": { "description": "Person search to freeze; no cursor.", "$ref": "#/components/schemas/PersonSearchRequest" }, "entries": { "description": "Workspace entry search to freeze; private entries require listId. No cursor.", "$ref": "#/components/schemas/MineSearchRequest" } }, "additionalProperties": false }, "CatalogEntry": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "shortLabel": { "type": [ "null", "string" ] }, "displayCode": { "type": [ "null", "string" ] }, "registerCode": { "type": [ "null", "string" ] }, "level": { "type": [ "null", "integer" ], "format": "int32" }, "statement": { "type": [ "null", "string" ] }, "unit": { "type": [ "null", "string" ] }, "roleLabel": { "type": [ "null", "string" ] }, "roleLabelPlural": { "type": [ "null", "string" ] }, "companyCount": { "type": [ "null", "integer" ], "format": "int64" }, "fieldDetailSince": { "type": [ "null", "string" ], "format": "date" }, "detailCoverage": { "type": [ "null", "string" ] }, "parentCode": { "type": [ "null", "string" ] }, "parentCodes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "geographyId": { "type": [ "null", "string" ] }, "geographyType": { "type": [ "null", "string" ] }, "datasetVersion": { "type": [ "null", "string" ] }, "childCount": { "type": [ "null", "integer" ], "format": "int32" }, "refCount": { "type": [ "null", "integer" ], "format": "int64" }, "path": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CatalogPathEntry" } }, "sort": { "type": [ "null", "integer" ], "format": "int32" } } }, "CatalogPathEntry": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" } } }, "ChangeData": { "required": [ "kind" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/ChangeDataFirmenbuchChangeData" }, { "$ref": "#/components/schemas/ChangeDataGisaChangeData" }, { "$ref": "#/components/schemas/ChangeDataNoticeChangeData" }, { "$ref": "#/components/schemas/ChangeDataDocumentChangeData" }, { "$ref": "#/components/schemas/ChangeDataFundingChangeData" }, { "$ref": "#/components/schemas/ChangeDataShamListChangeData" }, { "$ref": "#/components/schemas/ChangeDataIdentityChangeData" }, { "$ref": "#/components/schemas/ChangeDataEviChangeData" } ], "discriminator": { "propertyName": "kind", "mapping": { "firmenbuch": "#/components/schemas/ChangeDataFirmenbuchChangeData", "gisa": "#/components/schemas/ChangeDataGisaChangeData", "notices": "#/components/schemas/ChangeDataNoticeChangeData", "documents": "#/components/schemas/ChangeDataDocumentChangeData", "funding": "#/components/schemas/ChangeDataFundingChangeData", "shamList": "#/components/schemas/ChangeDataShamListChangeData", "identity": "#/components/schemas/ChangeDataIdentityChangeData", "evi": "#/components/schemas/ChangeDataEviChangeData" } } }, "ChangeDataDocumentChangeData": { "required": [ "kind" ], "properties": { "kind": { "enum": [ "documents" ], "type": "string" }, "document": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyDocument" } ] } } }, "ChangeDataEviChangeData": { "required": [ "sourceUrl", "functions", "kind" ], "properties": { "kind": { "enum": [ "evi" ], "type": "string" }, "sourceUrl": { "type": "string" }, "entryDate": { "type": [ "null", "string" ], "format": "date" }, "effectiveDate": { "type": [ "null", "string" ], "format": "date" }, "functions": { "type": "array", "items": { "$ref": "#/components/schemas/EviChangedFunction" } } } }, "ChangeDataFirmenbuchChangeData": { "required": [ "number", "changes", "kind" ], "properties": { "kind": { "enum": [ "firmenbuch" ], "type": "string" }, "number": { "type": "string" }, "text": { "type": [ "null", "string" ] }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/FilingChange" } }, "person": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyHolder" } ], "default": null }, "function": { "type": [ "null", "string" ], "default": null }, "since": { "type": [ "null", "string" ], "format": "date", "default": null } } }, "ChangeDataFundingChangeData": { "required": [ "changeKind", "amount", "currency", "measure", "year", "source", "kind" ], "properties": { "kind": { "enum": [ "funding" ], "type": "string" }, "changeKind": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "previousAmount": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": "string" }, "measure": { "type": "string" }, "year": { "type": "integer", "format": "int32" }, "department": { "type": [ "null", "string" ] }, "source": { "type": "string" } } }, "ChangeDataGisaChangeData": { "required": [ "gisaNumber", "kind" ], "properties": { "kind": { "enum": [ "gisa" ], "type": "string" }, "gisaNumber": { "type": "string" }, "before": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GisaLicenseState" } ] }, "after": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GisaLicenseState" } ] } } }, "ChangeDataIdentityChangeData": { "required": [ "ids", "kind" ], "properties": { "kind": { "enum": [ "identity" ], "type": "string" }, "ids": { "type": "array", "items": { "type": "string" } }, "fromId": { "type": [ "null", "string" ], "default": null }, "intoId": { "type": [ "null", "string" ], "default": null }, "retainedId": { "type": [ "null", "string" ], "default": null }, "newId": { "type": [ "null", "string" ], "default": null } } }, "ChangeDataNoticeChangeData": { "required": [ "kind" ], "properties": { "kind": { "enum": [ "notices" ], "type": "string" }, "notice": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyNotice" } ] } } }, "ChangeDataShamListChangeData": { "required": [ "kind" ], "properties": { "kind": { "enum": [ "shamList" ], "type": "string" }, "publishedDate": { "type": [ "null", "string" ], "format": "date" }, "shamSince": { "type": [ "null", "string" ], "format": "date" }, "text": { "type": [ "null", "string" ] } } }, "ChangeEntry": { "required": [ "id", "sequence", "register", "type", "subject", "recordedAt", "summary", "detail", "fieldsChanged", "data" ], "type": "object", "properties": { "id": { "type": "string" }, "sequence": { "type": "integer", "format": "int64" }, "register": { "type": "string" }, "type": { "type": "string" }, "subject": { "$ref": "#/components/schemas/ChangeSubject" }, "occurredDate": { "type": [ "null", "string" ], "format": "date" }, "recordedAt": { "type": "string", "format": "date-time" }, "summary": { "type": "string" }, "detail": { "type": "string" }, "fieldsChanged": { "type": "array", "items": { "type": "string" } }, "data": { "$ref": "#/components/schemas/ChangeData" } } }, "ChangeSubject": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": [ "null", "string" ] } } }, "CheckUidRequest": { "required": [ "uid" ], "type": "object", "properties": { "uid": { "type": "string" } }, "additionalProperties": false }, "CheckUidResponse": { "required": [ "verification", "cached" ], "type": "object", "properties": { "verification": { "$ref": "#/components/schemas/UidVerification" }, "cached": { "type": "boolean" }, "companyMatch": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UidCompanyMatch" } ] } } }, "CodeLabel": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" } } }, "ColumnDto": { "required": [ "key", "kind", "label", "hidden" ], "type": "object", "properties": { "key": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": "string" }, "hidden": { "type": "boolean" }, "path": { "type": [ "null", "string" ], "default": null }, "field": { "type": [ "null", "string" ], "default": null }, "definition": { "$ref": "#/components/schemas/FieldDefinition" } } }, "ColumnInput": { "required": [ "kind" ], "type": "object", "properties": { "kind": { "type": "string" }, "path": { "type": [ "null", "string" ], "default": null }, "field": { "type": [ "null", "string" ], "default": null }, "label": { "type": [ "null", "string" ], "default": null }, "hidden": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ColumnsDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnDto" } } } }, "CompanyAccount": { "required": [ "year", "documentDate", "currency", "figures", "document" ], "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "documentDate": { "type": "string", "format": "date" }, "currency": { "type": "string" }, "employees": { "type": [ "null", "number" ], "format": "double" }, "figures": { "type": "object", "properties": { "capitalizedOwnWork": { "type": "number", "default": null }, "fixedAssets": { "type": "number", "default": null }, "totalAssets": { "type": "number", "default": null }, "balanceSheetProfit": { "type": "number", "default": null }, "equity": { "type": "number", "default": null }, "calledUpCapital": { "type": "number", "default": null }, "financialAssets": { "type": "number", "default": null }, "receivables": { "type": "number", "default": null }, "tradeReceivables": { "type": "number", "default": null }, "retainedEarnings": { "type": "number", "default": null }, "intangibleAssets": { "type": "number", "default": null }, "capitalReserves": { "type": "number", "default": null }, "shortTermReceivables": { "type": "number", "default": null }, "shortTermLiabilities": { "type": "number", "default": null }, "longTermReceivables": { "type": "number", "default": null }, "longTermLiabilities": { "type": "number", "default": null }, "cashAndCashEquivalents": { "type": "number", "default": null }, "deferredIncome": { "type": "number", "default": null }, "prepaidExpenses": { "type": "number", "default": null }, "provisions": { "type": "number", "default": null }, "tangibleAssets": { "type": "number", "default": null }, "currentAssets": { "type": "number", "default": null }, "liabilities": { "type": "number", "default": null }, "tradePayables": { "type": "number", "default": null }, "inventories": { "type": "number", "default": null }, "profitLossCarriedForward": { "type": "number", "default": null }, "securities": { "type": "number", "default": null }, "depreciation": { "type": "number", "default": null }, "releaseOfRetainedEarnings": { "type": "number", "default": null }, "financialAssetExpenses": { "type": "number", "default": null }, "inventoryChanges": { "type": "number", "default": null }, "operatingIncome": { "type": "number", "default": null }, "incomeBeforeTax": { "type": "number", "default": null }, "participationIncome": { "type": "number", "default": null }, "securitiesIncome": { "type": "number", "default": null }, "financialIncome": { "type": "number", "default": null }, "netIncome": { "type": "number", "default": null }, "personnelExpenses": { "type": "number", "default": null }, "otherOperatingExpenses": { "type": "number", "default": null }, "otherOperatingIncome": { "type": "number", "default": null }, "otherInterestIncome": { "type": "number", "default": null }, "socialExpenses": { "type": "number", "default": null }, "taxExpenses": { "type": "number", "default": null }, "revenue": { "type": "number", "default": null }, "goodsAndMaterialsPurchases": { "type": "number", "default": null }, "interestExpenses": { "type": "number", "default": null }, "employees": { "type": "number", "default": null } }, "additionalProperties": false, "description": "Known figures only, keyed exclusively by the key-figures catalogue codes; unknown values are omitted." }, "document": { "$ref": "#/components/schemas/AccountDocument" }, "investmentGrants": { "type": [ "null", "number" ], "format": "double", "default": null }, "otherLiabilities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AccountLiability" }, "default": null } } }, "CompanyAddress": { "required": [ "kind", "current", "source" ], "type": "object", "properties": { "kind": { "type": "string" }, "street": { "type": [ "null", "string" ] }, "zip": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "since": { "type": [ "null", "string" ], "format": "date" }, "current": { "type": "boolean" }, "source": { "type": "string" }, "country": { "type": [ "null", "string" ], "default": null }, "addressId": { "type": [ "null", "string" ] }, "matchStatus": { "type": [ "null", "string" ] }, "datasetVersion": { "type": [ "null", "string" ] }, "unit": { "type": [ "null", "string" ] }, "until": { "type": [ "null", "string" ], "format": "date" } } }, "CompanyAggregateGroup": { "required": [ "groupBy", "total", "ungrouped", "buckets" ], "type": "object", "properties": { "groupBy": { "type": "string" }, "total": { "type": "integer", "format": "int64" }, "ungrouped": { "type": "integer", "format": "int64" }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyBucket" } } } }, "CompanyAggregateRequest": { "type": "object", "properties": { "groupBy": { "maxItems": 6, "uniqueItems": true, "type": "array", "items": { "enum": [ "legalForm", "industry", "city", "zip", "state", "court" ], "type": "string" }, "description": "Optional dimensions for bucket counts. Omit or use [] for totals and ungrouped metrics." }, "top": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 50 }, "minCount": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 }, "excludeOwnFilter": { "type": "boolean", "default": false }, "metrics": { "maxItems": 8, "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CompanyMetricRequest" } }, "where": { "default": null, "$ref": "#/components/schemas/Filter" }, "filterVersion": { "type": "integer", "format": "int32", "default": 1 }, "q": { "type": [ "null", "string" ], "default": null }, "place": { "type": [ "null", "string" ], "default": null }, "status": { "type": [ "null", "string" ], "default": null }, "legalForm": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "industry": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "trade": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "court": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "figures": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FigureRange" }, "default": null } }, "additionalProperties": false }, "CompanyAggregateResponse": { "required": [ "total", "groups" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAggregateGroup" } }, "metrics": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyMetricValue" }, "default": null } } }, "CompanyBatchItem": { "required": [ "requested", "status", "candidates" ], "type": "object", "properties": { "requested": { "type": "string" }, "id": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/CompanyBatchStatus" }, "company": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyResponse" } ] }, "candidates": { "type": "array", "items": { "type": "string" } } } }, "CompanyBatchRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "CompanyBatchResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyBatchItem" } } } }, "CompanyBatchStatus": { "enum": [ "ok", "merged", "notFound", "ambiguous" ], "type": "string", "description": "Open enum; ignore unknown values." }, "CompanyBucket": { "required": [ "key", "label", "count" ], "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "format": "int64" } } }, "CompanyCapital": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" } } }, "CompanyDocument": { "required": [ "key", "hasParsedAccounts" ], "type": "object", "properties": { "key": { "type": "string" }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "documentDate": { "type": [ "null", "string" ], "format": "date" }, "format": { "type": [ "null", "string" ] }, "hasParsedAccounts": { "type": "boolean" } } }, "CompanyFigures": { "required": [ "year", "currency" ], "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "totalAssets": { "type": [ "null", "number" ], "format": "double" }, "revenue": { "type": [ "null", "number" ], "format": "double" }, "equity": { "type": [ "null", "number" ], "format": "double" }, "employees": { "type": [ "null", "number" ], "format": "double" } } }, "CompanyFiling": { "required": [ "number", "changes", "source" ], "type": "object", "properties": { "number": { "type": "string" }, "executionDate": { "type": [ "null", "string" ], "format": "date" }, "caseNumber": { "type": [ "null", "string" ] }, "changeType": { "type": [ "null", "string" ] }, "text": { "type": [ "null", "string" ] }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/FilingChange" } }, "source": { "type": "string" }, "court": { "type": [ "null", "string" ], "default": null }, "legalDate": { "type": [ "null", "string" ], "format": "date", "default": null }, "line": { "type": [ "null", "string" ], "default": null }, "current": { "type": [ "null", "boolean" ], "default": null }, "function": { "type": [ "null", "string" ], "default": null }, "insolvencyEvent": { "type": [ "null", "string" ], "default": null } } }, "CompanyFlags": { "required": [ "hasNotice", "isShamCompany" ], "type": "object", "properties": { "hasNotice": { "type": "boolean" }, "isShamCompany": { "type": "boolean" } } }, "CompanyFunding": { "required": [ "year", "measure", "amount", "currency", "source", "asOf" ], "type": "object", "properties": { "year": { "type": "integer", "format": "int32" }, "program": { "type": [ "null", "string" ] }, "measure": { "type": "string" }, "department": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "source": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "measureId": { "type": [ "null", "string" ], "default": null }, "note": { "type": [ "null", "string" ], "default": null }, "recipient": { "type": [ "null", "string" ], "default": null }, "kur": { "type": [ "null", "string" ], "default": null }, "legalForm": { "type": [ "null", "string" ], "default": null }, "zip": { "type": [ "null", "string" ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "industry": { "type": [ "null", "string" ], "default": null }, "oenace": { "type": [ "null", "string" ], "default": null } } }, "CompanyFundingPage": { "required": [ "items", "summary" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFunding" } }, "nextCursor": { "type": [ "null", "string" ] }, "summary": { "$ref": "#/components/schemas/FundingSummary" } } }, "CompanyHolder": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "type": { "type": [ "null", "string" ], "default": null }, "country": { "type": [ "null", "string" ], "default": null }, "functionCount": { "type": [ "null", "integer" ], "format": "int32", "default": null } } }, "CompanyIndustry": { "required": [ "oenace" ], "type": "object", "properties": { "oenace": { "type": "string" }, "label": { "type": [ "null", "string" ] } } }, "CompanyIndustryAssignment": { "required": [ "oenace", "main", "source" ], "type": "object", "properties": { "oenace": { "type": "string" }, "label": { "type": [ "null", "string" ] }, "main": { "type": "boolean" }, "source": { "type": "string" } } }, "CompanyInsolvency": { "required": [ "status", "sources" ], "type": "object", "properties": { "status": { "type": "string" }, "since": { "type": [ "null", "string" ], "format": "date" }, "sources": { "type": "array", "items": { "type": "string" } }, "inProceeding": { "type": [ "null", "boolean" ] }, "sinceSource": { "type": [ "null", "string" ] } } }, "CompanyLicense": { "required": [ "gisaNumber", "trade", "holder", "source", "description" ], "type": "object", "properties": { "gisaNumber": { "type": "string" }, "trade": { "$ref": "#/components/schemas/CompanyTrade" }, "status": { "type": [ "null", "string" ] }, "holder": { "$ref": "#/components/schemas/CompanyHolder" }, "seat": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySeat" } ] }, "source": { "type": "string" }, "description": { "type": "string" }, "historicalTrade": { "type": [ "null", "boolean" ], "default": null } } }, "CompanyMatchCandidate": { "required": [ "id", "name", "confidence" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "confidence": { "type": "number", "format": "double" }, "fnr": { "type": [ "null", "string" ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "legalForm": { "type": [ "null", "string" ], "default": null }, "registeredDate": { "type": [ "null", "string" ], "format": "date", "default": null } } }, "CompanyMatchStatus": { "enum": [ "matched", "ambiguous", "unmatched" ], "type": "string", "description": "Open enum; ignore unknown values." }, "CompanyMetricRequest": { "required": [ "field", "operation" ], "type": "object", "properties": { "field": { "type": "string" }, "operation": { "type": "string" } }, "additionalProperties": false }, "CompanyMetricValue": { "required": [ "field", "operation", "knownCount", "missingCount" ], "type": "object", "properties": { "field": { "type": "string" }, "operation": { "type": "string" }, "value": { "type": [ "null", "number" ], "format": "double" }, "knownCount": { "type": "integer", "format": "int64" }, "missingCount": { "type": "integer", "format": "int64" } } }, "CompanyNameEntry": { "required": [ "id", "fnr", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "fnr": { "type": "string" }, "name": { "type": "string" } } }, "CompanyNetworkEdge": { "required": [ "source", "target", "relationship", "current", "functions", "sources" ], "type": "object", "properties": { "source": { "type": "string" }, "target": { "type": "string" }, "relationship": { "$ref": "#/components/schemas/NetworkRelationship" }, "current": { "type": "boolean" }, "functions": { "type": "array", "items": { "type": "string" } }, "sharePercent": { "type": [ "null", "number" ], "format": "double" }, "capital": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyCapital" } ] }, "sources": { "type": "array", "items": { "type": "string" } }, "uncertainty": { "type": [ "null", "string" ] } } }, "CompanyNetworkNode": { "required": [ "id", "type", "label", "central", "hasMore" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/NetworkNodeType" }, "label": { "type": "string" }, "central": { "type": "boolean" }, "hasMore": { "type": "boolean" } } }, "CompanyNetworkResponse": { "required": [ "depth", "nodes", "edges" ], "type": "object", "properties": { "depth": { "type": "integer", "format": "int32" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNetworkNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNetworkEdge" } } } }, "CompanyNotice": { "required": [ "kind", "source" ], "type": "object", "properties": { "kind": { "type": "string" }, "publishedDate": { "type": [ "null", "string" ], "format": "date" }, "removedDate": { "type": [ "null", "string" ], "format": "date" }, "caseNumber": { "type": [ "null", "string" ] }, "court": { "type": [ "null", "string" ] }, "text": { "type": [ "null", "string" ] }, "source": { "type": "string" }, "note": { "type": [ "null", "string" ], "default": null }, "supplement": { "type": [ "null", "string" ], "default": null }, "category": { "type": [ "null", "string" ], "default": null }, "transaction": { "type": [ "null", "string" ], "default": null }, "address": { "type": [ "null", "string" ], "default": null }, "name": { "type": [ "null", "string" ], "default": null }, "shamSince": { "type": [ "null", "string" ], "format": "date", "default": null }, "uid": { "type": [ "null", "string" ], "default": null } } }, "CompanyPerson": { "required": [ "person", "function", "source", "evidence" ], "type": "object", "properties": { "person": { "$ref": "#/components/schemas/CompanyHolder" }, "function": { "$ref": "#/components/schemas/CodeLabel" }, "since": { "type": [ "null", "string" ], "format": "date" }, "until": { "type": [ "null", "string" ], "format": "date" }, "capital": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyCapital" } ] }, "source": { "type": "string" }, "sharePercent": { "type": [ "null", "number" ], "format": "double" }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipEvidence" } }, "uncertainty": { "type": [ "null", "string" ], "default": null }, "sourceUrls": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "status": { "type": [ "null", "string" ], "default": null } } }, "CompanyResolveInput": { "required": [ "ref", "name" ], "type": "object", "properties": { "ref": { "type": "string" }, "name": { "type": "string" }, "street": { "type": [ "null", "string" ], "default": null }, "zip": { "type": [ "null", "string" ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "country": { "type": [ "null", "string" ], "default": null }, "uid": { "type": [ "null", "string" ], "default": null }, "registry": { "type": [ "null", "string" ], "default": null }, "kind": { "type": "string", "default": "company" }, "fnr": { "type": [ "null", "string" ], "default": null }, "akteId": { "type": [ "null", "string" ], "default": null } }, "additionalProperties": false }, "CompanyResolveRequest": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResolveInput" } }, "minConfidence": { "type": "number", "format": "double", "default": 0.8 } }, "additionalProperties": false }, "CompanyResolveResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResolveResult" } } } }, "CompanyResolveResult": { "required": [ "ref", "status", "method", "candidates" ], "type": "object", "properties": { "ref": { "type": "string" }, "status": { "$ref": "#/components/schemas/CompanyMatchStatus" }, "id": { "type": [ "null", "string" ] }, "matchedName": { "type": [ "null", "string" ] }, "confidence": { "type": [ "null", "number" ], "format": "double" }, "method": { "type": "string" }, "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyMatchCandidate" } } } }, "CompanyResponse": { "required": [ "name", "status", "websites", "insolvency", "flags", "id", "type", "identifiers", "formerIds" ], "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "legalForm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "seat": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySeat" } ] }, "industry": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyIndustry" } ] }, "court": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "registeredDate": { "type": [ "null", "string" ], "format": "date" }, "purpose": { "type": [ "null", "string" ] }, "websites": { "type": "array", "items": { "type": "string" } }, "webPresence": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyWebsite" } }, "uidVerifications": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyUidVerification" } }, "signerCount": { "type": [ "null", "integer" ], "format": "int32" }, "insolvency": { "$ref": "#/components/schemas/CompanyInsolvency" }, "flags": { "$ref": "#/components/schemas/CompanyFlags" }, "figures": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyFigures" } ] }, "accounts": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyAccount" } ] }, "people": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyPerson" } ] }, "licenses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyLicense" } ] }, "funding": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyFundingPage" } ] }, "notices": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" } ] }, "documents": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyDocument" } ] }, "filings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyFiling" } ] }, "addresses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyAddress" } ] }, "industries": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyIndustryAssignment" } ] }, "id": { "type": "string" }, "type": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } }, "formerIds": { "type": "array", "items": { "type": "string" } }, "changes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfChangeEntry" } ] }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ] } } }, "CompanySearchRequest": { "type": "object", "properties": { "sort": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySearchSort" } ], "default": null }, "limit": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 25 }, "cursor": { "type": [ "null", "string" ], "default": null }, "includeSummary": { "type": "boolean", "default": false }, "where": { "default": null, "$ref": "#/components/schemas/Filter" }, "filterVersion": { "type": "integer", "format": "int32", "default": 1 }, "q": { "type": [ "null", "string" ], "default": null }, "place": { "type": [ "null", "string" ], "default": null }, "status": { "type": [ "null", "string" ], "default": null }, "legalForm": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "industry": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "trade": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "court": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "figures": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FigureRange" }, "default": null } }, "additionalProperties": false }, "CompanySearchSort": { "type": "object", "properties": { "by": { "type": "string", "default": "name" }, "direction": { "type": "string", "default": "asc" } }, "additionalProperties": false }, "CompanySearchSummary": { "required": [ "total", "asOf", "request" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int64" }, "asOf": { "type": "string", "format": "date-time" }, "request": { "$ref": "#/components/schemas/CompanySearchRequest" }, "definition": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false }, "ruleUnavailableReason": { "type": [ "null", "string" ] } } }, "CompanySeat": { "type": "object", "properties": { "street": { "type": [ "null", "string" ] }, "zip": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "municipality": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "location": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GeoLocation" } ] }, "addressId": { "type": [ "null", "string" ] }, "matchStatus": { "type": [ "null", "string" ] }, "coordinateSource": { "type": [ "null", "string" ] }, "datasetVersion": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] } } }, "CompanyTopItem": { "required": [ "group", "company", "value" ], "type": "object", "properties": { "group": { "$ref": "#/components/schemas/TopGroup" }, "company": { "$ref": "#/components/schemas/TopCompany" }, "value": { "type": "number", "format": "double" }, "year": { "type": [ "null", "integer" ], "format": "int32" } } }, "CompanyTopRequest": { "type": "object", "properties": { "per": { "type": "string", "default": "state" }, "by": { "type": "string", "default": "figures.totalAssets" }, "where": { "default": null, "$ref": "#/components/schemas/Filter" }, "filterVersion": { "type": "integer", "format": "int32", "default": 1 }, "q": { "type": [ "null", "string" ], "default": null }, "place": { "type": [ "null", "string" ], "default": null }, "status": { "type": [ "null", "string" ], "default": null }, "legalForm": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "industry": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "trade": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "court": { "oneOf": [ { "maxLength": 200, "type": "string" }, { "maxItems": 1000, "type": "array", "items": { "maxLength": 200, "type": "string" } } ], "default": null }, "figures": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FigureRange" }, "default": null } }, "additionalProperties": false }, "CompanyTrade": { "required": [ "key", "label" ], "type": "object", "properties": { "key": { "type": "integer", "format": "int32" }, "label": { "type": "string" } } }, "CompanyUidVerification": { "required": [ "uid", "status", "verifiedAt", "companyMatchStatus" ], "type": "object", "properties": { "uid": { "type": "string" }, "status": { "type": "string" }, "verifiedAt": { "type": "string", "format": "date-time" }, "companyMatchStatus": { "type": "string" } } }, "CompanyWebsite": { "required": [ "url", "role", "lastSeen" ], "type": "object", "properties": { "url": { "type": "string" }, "role": { "type": "string" }, "lastSeen": { "type": "string", "format": "date" } } }, "ConfirmImportDto": { "required": [ "imported", "summary" ], "type": "object", "properties": { "imported": { "type": "integer", "format": "int32" }, "summary": { "$ref": "#/components/schemas/ImportSummary" }, "job": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListWriteJobDto" } ], "default": null } } }, "ContactFieldValue": { "required": [ "field", "value" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/CreateFieldDto" }, "value": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "additionalProperties": false }, "CreateExportRequest": { "required": [ "format" ], "type": "object", "properties": { "format": { "enum": [ "csv", "xlsx" ], "type": "string" }, "listId": { "type": [ "null", "string" ], "default": null }, "query": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false, "default": null }, "q": { "type": [ "null", "string" ], "default": null }, "columns": { "maxItems": 100, "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Columnable catalog paths and fields.. Defaults to the list's columns in order, or name, seat.city, industry, registeredDate.", "default": null }, "people": { "type": "boolean", "description": "One row per person of a query with subject person and no listId, never birth dates, birth years or ages.", "default": false } }, "additionalProperties": false }, "CreateFieldDto": { "required": [ "label" ], "type": "object", "properties": { "label": { "type": "string" }, "type": { "enum": [ "text", "options", "number", "date", "bool" ], "type": "string", "description": "Value type: text, one of the configured options, number, ISO date, or boolean.", "default": "text" }, "options": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Required only for type options: up to 1000 distinct nonempty choices, each at most 200 characters. Otherwise omit or use null.", "default": null }, "unit": { "type": [ "null", "string" ], "description": "Optional display unit, at most 100 characters; only for type number.", "default": null }, "reuseExisting": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CreateImportDto": { "required": [ "fileName", "mapping", "rows" ], "type": "object", "properties": { "fileName": { "type": "string" }, "mapping": { "type": "object", "additionalProperties": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } }, "additionalProperties": false }, "CreateListDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": [ "null", "string" ], "default": null }, "columns": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ColumnInput" }, "default": null }, "copyFrom": { "type": [ "null", "string" ], "default": null }, "items": { "type": [ "null", "array" ], "items": { "type": "object", "anyOf": [ { "required": [ "id" ] }, { "required": [ "ownRecordId" ] }, { "required": [ "ownRecord" ] } ], "properties": { "id": { "type": [ "null", "string" ], "default": null }, "ownRecordId": { "type": [ "null", "string" ], "default": null }, "ownRecord": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOwnRecordDto" } ], "default": null } }, "additionalProperties": false }, "default": null }, "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateRuleDto" }, "default": null } }, "additionalProperties": false }, "CreateNoteDto": { "required": [ "subject", "text" ], "type": "object", "properties": { "subject": { "type": "string" }, "text": { "type": "string" } }, "additionalProperties": false }, "CreateOwnRecordDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "note": { "type": [ "null", "string" ], "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Values of Firmenakte fields by field catalog path, for example {\"seat.city\": \"Wien\", \"country\": \"AT\", \"website\": \"https://example.at\"}. Single-value fields outside the status group; the name is the record's own.", "default": null }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears.", "default": null } }, "additionalProperties": false }, "CreateRuleDto": { "required": [ "rule" ], "type": "object", "properties": { "rule": { "$ref": "#/components/schemas/RuleDefinition" }, "runNow": { "type": "boolean", "default": false } }, "additionalProperties": false }, "CreditPrices": { "required": [ "listUpdate", "digestEmail", "exportRows", "exportMinimum" ], "type": "object", "properties": { "listUpdate": { "type": "integer", "format": "int32" }, "digestEmail": { "type": "integer", "format": "int32" }, "exportRows": { "type": "integer", "format": "int32" }, "exportMinimum": { "type": "integer", "format": "int32" } } }, "CursorPageOfCatalogEntry": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogEntry" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfChangeEntry": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeEntry" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyAccount": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAccount" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyAddress": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAddress" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyDocument": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDocument" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyFiling": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFiling" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyIndustryAssignment": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyIndustryAssignment" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyLicense": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyLicense" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyNameEntry": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNameEntry" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyNotice": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNotice" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyPerson": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyPerson" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfCompanyTopItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTopItem" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfEntityActivityDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityActivityDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfEntityListDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntityListDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfExportDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExportDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfFieldDefinition": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDefinition" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfFieldDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfGeoPoint": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoPoint" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfImportRowDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRowDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfListDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfListEntryDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListEntryDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfListEventDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListEventDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfListRunDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListRunDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfMineSearchRow": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/MineSearchRow" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfNoteDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NoteDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfOwnRecordDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OwnRecordDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfPersonFunction": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonFunction" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfPersonLicense": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonLicense" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfPersonNameEntry": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonNameEntry" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfPersonRegistration": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRegistration" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfPlaceEntry": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PlaceEntry" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfReferenceAddressResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceAddressResponse" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfRuleDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RuleDto" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "CursorPageOfSimilarCompany": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SimilarCompany" } }, "nextCursor": { "type": [ "null", "string" ] }, "total": { "type": [ "null", "integer" ], "format": "int64", "default": null } } }, "EmptyRuleTrigger": { "type": "object", "additionalProperties": false }, "EntityActivityDto": { "required": [ "at", "kind" ], "type": "object", "properties": { "at": { "type": "string", "format": "date-time" }, "kind": { "type": "string" }, "list": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EntityActivityList" } ] }, "field": { "type": [ "null", "string" ] }, "value": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "by": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AccountAuthor" } ] }, "summary": { "type": "string", "description": "Readable account activity text; clients display it even for unknown kinds.", "default": "" } } }, "EntityActivityList": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "EntityListDto": { "required": [ "id", "name", "entryId", "excluded", "since" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "entryId": { "type": "string" }, "excluded": { "type": "boolean", "description": "True when manually excluded; excluded lists remain visible here and can be restored." }, "since": { "type": "string", "format": "date-time" }, "color": { "type": [ "null", "string" ], "default": null }, "reason": { "type": "string", "description": "Membership origin: manual, import, query, chat or migration.", "default": "manual" } } }, "EntityResponse": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/EntityResponseCompanyResponse" }, { "$ref": "#/components/schemas/EntityResponsePersonResponse" } ], "discriminator": { "propertyName": "$type" } }, "EntityResponseCompanyResponse": { "required": [ "name", "status", "websites", "insolvency", "flags", "id", "type", "identifiers", "formerIds" ], "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "legalForm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "seat": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySeat" } ] }, "industry": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyIndustry" } ] }, "court": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "registeredDate": { "type": [ "null", "string" ], "format": "date" }, "purpose": { "type": [ "null", "string" ] }, "websites": { "type": "array", "items": { "type": "string" } }, "webPresence": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyWebsite" } }, "uidVerifications": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyUidVerification" } }, "signerCount": { "type": [ "null", "integer" ], "format": "int32" }, "insolvency": { "$ref": "#/components/schemas/CompanyInsolvency" }, "flags": { "$ref": "#/components/schemas/CompanyFlags" }, "figures": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyFigures" } ] }, "accounts": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyAccount" } ] }, "people": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyPerson" } ] }, "licenses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyLicense" } ] }, "funding": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyFundingPage" } ] }, "notices": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" } ] }, "documents": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyDocument" } ] }, "filings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyFiling" } ] }, "addresses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyAddress" } ] }, "industries": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyIndustryAssignment" } ] }, "id": { "type": "string" }, "type": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } }, "formerIds": { "type": "array", "items": { "type": "string" } }, "changes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfChangeEntry" } ] }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ] } } }, "EntityResponsePersonResponse": { "required": [ "name", "id", "type", "identifiers", "formerIds" ], "properties": { "name": { "type": "object", "properties": { "first": { "type": [ "null", "string" ] }, "last": { "type": [ "null", "string" ] }, "titlePrefix": { "type": [ "null", "string" ] }, "titleSuffix": { "type": [ "null", "string" ] } } }, "functionCount": { "type": [ "null", "integer" ], "format": "int32" }, "functions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonFunction" } ] }, "licenses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonLicense" } ] }, "notices": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" } ] }, "registrations": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonRegistration" } ] }, "id": { "type": "string" }, "type": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } }, "formerIds": { "type": "array", "items": { "type": "string" } }, "changes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfChangeEntry" } ] }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ] } } }, "EntitySearchItem": { "required": [ "id", "type", "name", "identifiers" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } } } }, "EntitySearchPage": { "required": [ "items", "nextCursor" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntitySearchItem" } }, "nextCursor": { "type": [ "null", "string" ] }, "summary": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySearchSummary" } ], "default": null } } }, "EntityValuesDto": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears." }, "fields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FieldDto" }, "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/SyncedCell" }, "default": null } } }, "EntriesWriteDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EntryWriteResultDto" } }, "job": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListWriteJobDto" } ], "default": null } } }, "EntrySearchDto": { "type": "object", "properties": { "where": { "default": null, "$ref": "#/components/schemas/Filter" }, "q": { "type": [ "null", "string" ], "default": null }, "sort": { "type": "string", "default": "name" }, "limit": { "type": "integer", "format": "int32", "default": 25 }, "cursor": { "type": [ "null", "string" ], "default": null }, "runId": { "type": [ "null", "string" ], "default": null }, "excluded": { "type": [ "null", "boolean" ], "default": null } }, "additionalProperties": false }, "EntryWriteResultDto": { "required": [ "requested", "entryId", "status" ], "type": "object", "properties": { "requested": { "type": "string" }, "entryId": { "type": "string" }, "status": { "type": "string" }, "akte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListEntryAkteDto" } ], "default": null }, "ownRecord": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListEntryOwnRecordDto" } ], "default": null } } }, "EvaluationDto": { "type": "object", "oneOf": [ { "required": [ "run" ] }, { "required": [ "members", "wouldAdd", "wouldRemove", "sample" ] } ], "properties": { "run": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListRunDto" } ], "default": null }, "members": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "wouldAdd": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "wouldRemove": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "sample": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ListEventSubject" }, "default": null } } }, "EviChangedFunction": { "required": [ "code" ], "type": "object", "properties": { "personId": { "type": [ "null", "string" ] }, "code": { "type": "string" }, "sharePercent": { "type": [ "null", "number" ], "format": "double" } } }, "ExportDto": { "required": [ "id", "status", "format", "createdAt", "asOf", "rows", "rowsDone", "credits", "columns" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "enum": [ "queued", "running", "succeeded", "failed" ], "type": "string", "description": "Open enum; ignore unknown statuses." }, "format": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "asOf": { "type": "string", "format": "date-time" }, "rows": { "type": "integer", "format": "int64" }, "rowsDone": { "type": "integer", "format": "int64" }, "credits": { "type": "integer", "format": "int32" }, "columns": { "type": "array", "items": { "type": "string" } }, "resultUrl": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "error": { "type": [ "null", "string" ] } } }, "FieldDefinition": { "required": [ "path", "label", "type", "filterable", "sortable", "columnable", "appliesTo", "scope" ], "type": "object", "properties": { "path": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "ops": { "type": [ "null", "array" ], "items": { "type": "string" } }, "filterable": { "type": "boolean", "default": true }, "sortable": { "type": "boolean", "default": false }, "columnable": { "type": "boolean", "default": true }, "register": { "type": [ "null", "string" ], "default": "firmenbuch" }, "appliesTo": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "scope": { "type": "string", "default": "public" }, "yearBound": { "type": [ "null", "boolean" ], "default": null }, "quantifiers": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "fields": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "subfields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FieldDefinition" }, "default": null }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FieldOption" }, "default": null }, "group": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FieldGroup" } ], "default": null }, "rank": { "type": [ "null", "integer" ], "format": "int32", "default": null }, "unit": { "type": [ "null", "string" ], "default": null }, "fieldRef": { "type": [ "null", "string" ], "default": null }, "aliases": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "projection": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FieldProjection" } ], "default": null }, "catalog": { "type": [ "null", "string" ], "default": null }, "filterVia": { "type": [ "null", "string" ], "default": null }, "searchTerms": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null } } }, "FieldDto": { "required": [ "id", "key", "label", "type" ], "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "options": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "unit": { "type": [ "null", "string" ], "default": null }, "clearedValues": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "listCount": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "valueCount": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "definition": { "$ref": "#/components/schemas/FieldDefinition" } } }, "FieldGroup": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "rank": { "type": [ "null", "integer" ], "format": "int32" } } }, "FieldOption": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" } } }, "FieldProjection": { "required": [ "default", "reads" ], "type": "object", "properties": { "default": { "type": "string" }, "reads": { "type": "array", "items": { "type": "string" } }, "yearFrom": { "type": [ "null", "string" ], "default": null } } }, "FigureRange": { "required": [ "figure" ], "type": "object", "properties": { "figure": { "type": "string" }, "min": { "type": [ "null", "number" ], "format": "double", "default": null }, "max": { "type": [ "null", "number" ], "format": "double", "default": null } }, "additionalProperties": false }, "FilingChange": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" }, "text": { "type": [ "null", "string" ], "default": null }, "code": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ], "default": null }, "address": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyAddress" } ], "default": null }, "people": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CompanyPerson" }, "default": null } } }, "Filter": { "oneOf": [ { "required": [ "and" ], "type": "object", "properties": { "and": { "maxItems": 200, "type": "array", "items": { "$ref": "#/components/schemas/Filter" } } }, "additionalProperties": false }, { "required": [ "or" ], "type": "object", "properties": { "or": { "maxItems": 200, "type": "array", "items": { "$ref": "#/components/schemas/Filter" } } }, "additionalProperties": false }, { "required": [ "not" ], "type": "object", "properties": { "not": { "$ref": "#/components/schemas/Filter" } }, "additionalProperties": false }, { "required": [ "field", "op" ], "type": "object", "properties": { "field": { "type": "string", "description": "Path from the field catalog." }, "op": { "type": "string", "description": "eq, in, lt, lte, gt, gte, range, exists, contains, within, withinNext, beforeRelative, inBox or near." }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, { "anyOf": [ { "required": [ "min" ], "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ] }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } }, "additionalProperties": false }, { "required": [ "max" ], "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ] }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ] } }, "additionalProperties": false } ] }, { "required": [ "minLat", "maxLat", "minLng", "maxLng" ], "type": "object", "properties": { "minLat": { "type": "number" }, "maxLat": { "type": "number" }, "minLng": { "type": "number" }, "maxLng": { "type": "number" } }, "additionalProperties": false }, { "required": [ "lat", "lng", "radiusKm" ], "type": "object", "properties": { "lat": { "maximum": 90, "minimum": -90, "type": "number" }, "lng": { "maximum": 180, "minimum": -180, "type": "number" }, "radiusKm": { "maximum": 500, "exclusiveMinimum": 0, "type": "number" } }, "additionalProperties": false } ], "description": "Typed scalar, non-empty array, range {min?, max?}, calendar duration (years/months/weeks/days, no time components), inBox {minLat, maxLat, minLng, maxLng}, or near {lat, lng, radiusKm} as specified by the field and operator." } }, "additionalProperties": false }, { "required": [ "any", "field" ], "type": "object", "properties": { "any": { "$ref": "#/components/schemas/Filter" }, "field": { "type": "string", "description": "functions or shareholders; all requires at least one relationship." } }, "additionalProperties": false }, { "required": [ "all", "field" ], "type": "object", "properties": { "all": { "$ref": "#/components/schemas/Filter" }, "field": { "type": "string", "description": "functions or shareholders; all requires at least one relationship." } }, "additionalProperties": false }, { "required": [ "none", "field" ], "type": "object", "properties": { "none": { "$ref": "#/components/schemas/Filter" }, "field": { "type": "string", "description": "functions or shareholders; all requires at least one relationship." } }, "additionalProperties": false } ], "description": "Filter tree, at most 12 levels and 200 nodes. Missing values never satisfy a comparison, including under not." }, "FundingSummary": { "required": [ "count", "sum", "years" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "sum": { "type": "number", "format": "double" }, "years": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "asOf": { "type": [ "null", "string" ], "format": "date", "default": null } } }, "GeoCluster": { "required": [ "lat", "lng", "count" ], "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int64" }, "kind": { "type": [ "null", "string" ], "default": null } } }, "GeographicPlaceResponse": { "required": [ "id", "type", "code", "name", "active", "sourceDate", "datasetVersion", "parents" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "sourceDate": { "type": "string", "format": "date" }, "datasetVersion": { "type": "string" }, "parents": { "type": "array", "items": { "$ref": "#/components/schemas/AddressGeographyReference" } } } }, "GeoLocation": { "required": [ "lat", "lng" ], "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" } } }, "GeoPoint": { "required": [ "id", "name", "lat", "lng" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" }, "fnr": { "type": [ "null", "string" ], "default": null }, "kind": { "type": [ "null", "string" ], "default": null } } }, "GisaLicenseState": { "type": "object", "properties": { "status": { "type": [ "null", "string" ], "default": null }, "description": { "type": [ "null", "string" ], "default": null }, "tradeKey": { "type": [ "null", "integer" ], "format": "int32", "default": null }, "location": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GisaStateAddress" } ], "default": null } } }, "GisaStateAddress": { "type": "object", "properties": { "street": { "type": [ "null", "string" ], "default": null }, "houseNumber": { "type": [ "null", "string" ], "default": null }, "zip": { "type": [ "null", "string" ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "country": { "type": [ "null", "string" ], "default": null } } }, "IdentifierResolution": { "required": [ "requested", "reason" ], "type": "object", "properties": { "requested": { "type": "string" }, "reason": { "type": "string" } }, "additionalProperties": false }, "ImportChoice": { "required": [ "row" ], "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "akteId": { "type": [ "null", "string" ], "default": null }, "keepOwn": { "type": "boolean", "default": false } }, "additionalProperties": false }, "ImportDto": { "required": [ "id", "status", "fileName", "rows", "expiresAt", "summary", "report", "fields" ], "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "fileName": { "type": "string" }, "rows": { "type": "integer", "format": "int32" }, "expiresAt": { "type": "string", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/ImportSummary" }, "report": { "$ref": "#/components/schemas/CursorPageOfImportRowDto" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ImportFieldReport" } }, "job": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListWriteJobDto" } ], "default": null } } }, "ImportFieldReport": { "required": [ "field", "label", "type", "newOptions", "invalidValues" ], "type": "object", "properties": { "field": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "newOptions": { "type": "array", "items": { "type": "string" } }, "invalidValues": { "type": "integer", "format": "int32" } } }, "ImportRowDto": { "required": [ "row", "status", "ownRecord", "match", "alreadyPresent" ], "type": "object", "properties": { "row": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "ownRecord": { "$ref": "#/components/schemas/CreateOwnRecordDto" }, "match": { "$ref": "#/components/schemas/CompanyResolveResult" }, "akteId": { "type": [ "null", "string" ] }, "existingOwnRecordId": { "type": [ "null", "string" ] }, "alreadyPresent": { "type": "boolean" }, "fnr": { "type": [ "null", "string" ] } } }, "ImportSummary": { "required": [ "matched", "ambiguous", "unmatched", "alreadyPresent" ], "type": "object", "properties": { "matched": { "type": "integer", "format": "int32" }, "ambiguous": { "type": "integer", "format": "int32" }, "unmatched": { "type": "integer", "format": "int32" }, "alreadyPresent": { "type": "integer", "format": "int32" } } }, "ListDto": { "required": [ "id", "name", "stats", "revision" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": [ "null", "string" ] }, "stats": { "$ref": "#/components/schemas/Stats" }, "revision": { "type": "string" }, "hasRules": { "type": "boolean", "default": false }, "allSelectedPresent": { "type": [ "null", "boolean" ], "default": null }, "run": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListRunDto" } ], "default": null } } }, "ListEntryAkteDto": { "required": [ "id", "type", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "fnr": { "type": [ "null", "string" ], "default": null } } }, "ListEntryDto": { "required": [ "entryId", "match", "origin", "excluded", "addedAt" ], "type": "object", "properties": { "entryId": { "type": "string" }, "akte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListEntryAkteDto" } ] }, "ownRecord": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListEntryOwnRecordDto" } ] }, "match": { "$ref": "#/components/schemas/ListEntryMatchDto" }, "origin": { "type": "string" }, "excluded": { "type": "boolean" }, "addedAt": { "type": "string", "format": "date-time" }, "identityChanged": { "type": "boolean", "default": false }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "required": [ "value", "source" ], "type": "object", "properties": { "value": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": { "code": { "type": "string", "default": null }, "label": { "type": "string", "default": null }, "oenace": { "type": "string", "default": null }, "lat": { "type": "number", "default": null }, "lng": { "type": "number", "default": null } } } ] }, "source": { "type": "string" }, "asOf": { "type": "string", "format": "date" } } } ] }, "default": null }, "canonicalEntryId": { "type": [ "null", "string" ], "default": null } } }, "ListEntryMatchDto": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" }, "candidates": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null } } }, "ListEntryOwnRecordDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "ListEventDto": { "required": [ "seq", "listId", "type", "at", "baseline" ], "type": "object", "properties": { "seq": { "type": "integer", "format": "int64" }, "listId": { "type": "string" }, "runId": { "type": [ "null", "string" ] }, "type": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "baseline": { "type": "boolean" }, "entryId": { "type": [ "null", "string" ], "default": null }, "subject": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListEventSubject" } ], "default": null }, "reason": { "type": [ "null", "string" ], "default": null }, "id": { "type": [ "null", "string" ], "default": null }, "sequence": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "entryIds": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "flag": { "type": [ "null", "string" ], "default": null }, "entityIds": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null } } }, "ListEventSubject": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "null", "string" ] }, "name": { "type": "string" } } }, "ListRunDto": { "required": [ "id", "trigger", "evaluationDate", "startedAt", "added", "status", "baseline", "credits" ], "type": "object", "properties": { "id": { "type": "string" }, "trigger": { "type": "string" }, "evaluationDate": { "type": "string", "format": "date" }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": [ "null", "string" ], "format": "date-time" }, "added": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "baseline": { "type": "boolean" }, "credits": { "type": "integer", "format": "int32" }, "reason": { "type": [ "null", "string" ], "default": null }, "deliveries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RunDeliveryDto" }, "default": null } } }, "ListSchedule": { "type": "object", "properties": { "every": { "enum": [ "daily", "weekdays", "weekly", "monthly", "manual" ], "type": "string", "description": "Repeat daily, weekdays (Monday-Friday), weekly, monthly, or manual (no recurrence). Never more often than daily.", "default": "daily" }, "at": { "pattern": "^([01][0-9]|2[0-3]):00$", "type": [ "null", "string" ], "description": "Required for recurrence: a full hour HH:00 from 00:00 to 23:00 in Europe/Vienna. This schedule belongs to an independent query rule. Omit or use null for manual (no recurrence); an initial run is selected separately with runNow. Each query run uses the current listUpdate price.", "default": null }, "weekday": { "maximum": 6, "minimum": 0, "type": [ "null", "integer" ], "description": "Required only for weekly: 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. Otherwise omit or use null.", "format": "int32", "default": null }, "monthday": { "maximum": 28, "minimum": 1, "type": [ "null", "integer" ], "description": "Required only for monthly: day of month 1-28. Otherwise omit or use null.", "format": "int32", "default": null }, "timezone": { "enum": [ "Europe/Vienna" ], "type": "string", "description": "Always Europe/Vienna; daylight saving time is handled automatically.", "default": "Europe/Vienna" } }, "additionalProperties": false }, "ListWriteJobDto": { "required": [ "id", "kind", "listId", "status", "total", "done", "failed", "startedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "listId": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer", "format": "int64" }, "done": { "type": "integer", "format": "int64" }, "failed": { "type": "integer", "format": "int64" }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": [ "null", "string" ], "format": "date-time" }, "errorCode": { "type": [ "null", "string" ] } } }, "MeCreditsDto": { "required": [ "week", "allowance", "used", "topUp", "balance", "resetsAt", "prices" ], "type": "object", "properties": { "week": { "type": "string" }, "allowance": { "type": "integer", "format": "int32" }, "used": { "type": "integer", "format": "int64" }, "topUp": { "type": "integer", "format": "int64" }, "balance": { "type": "integer", "format": "int64" }, "resetsAt": { "type": "string", "format": "date-time" }, "prices": { "$ref": "#/components/schemas/CreditPrices" } } }, "MeDto": { "required": [ "workspace", "channel" ], "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/MeWorkspaceDto" }, "channel": { "type": "string" }, "id": { "type": [ "null", "string" ], "default": null }, "email": { "type": [ "null", "string" ], "default": null }, "name": { "type": [ "null", "string" ], "default": null }, "apiKey": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MeKeyDto" } ], "default": null } } }, "MeKeyDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "MeWorkspaceDto": { "required": [ "id", "name", "plan", "role" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string" }, "role": { "type": "string" } } }, "MineDto": { "required": [ "lists", "values" ], "type": "object", "properties": { "lists": { "$ref": "#/components/schemas/CursorPageOfEntityListDto" }, "values": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears." } } }, "MineGeoRequest": { "type": "object", "properties": { "listId": { "type": [ "null", "string" ], "default": null }, "query": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false, "default": null }, "q": { "type": [ "null", "string" ], "default": null }, "bbox": { "type": [ "null", "array" ], "items": { "type": "number", "format": "double" }, "default": null }, "zoom": { "type": "number", "format": "double", "default": 7 }, "cursor": { "type": [ "null", "string" ], "default": null }, "noLocationCursor": { "type": [ "null", "string" ], "default": null } }, "additionalProperties": false }, "MineGeoResponse": { "required": [ "clusters", "points", "noLocation", "entries", "withoutLocation" ], "type": "object", "properties": { "clusters": { "type": "array", "items": { "$ref": "#/components/schemas/GeoCluster" } }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/GeoPoint" } }, "noLocation": { "type": "integer", "format": "int64" }, "entries": { "$ref": "#/components/schemas/CursorPageOfGeoPoint" }, "withoutLocation": { "$ref": "#/components/schemas/CursorPageOfMineSearchRow" } } }, "MineSearchRequest": { "type": "object", "anyOf": [ { "required": [ "listId" ] }, { "required": [ "query" ] } ], "properties": { "listId": { "type": [ "null", "string" ], "default": null }, "query": { "required": [ "subject", "where" ], "type": [ "null", "object" ], "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false, "default": null }, "q": { "type": [ "null", "string" ], "default": null }, "sort": { "type": "string", "default": "name" }, "limit": { "type": "integer", "format": "int32", "default": 25 }, "cursor": { "type": [ "null", "string" ], "default": null }, "ownRecords": { "type": "boolean", "default": false }, "columns": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null } }, "additionalProperties": false }, "MineSearchRow": { "required": [ "id", "name", "kind", "mine" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "kind": { "type": "string" }, "mine": { "$ref": "#/components/schemas/MineDto" }, "sortValue": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "fnr": { "type": [ "null", "string" ], "default": null }, "legalFormCode": { "type": [ "null", "string" ], "default": null }, "legalFormLabel": { "type": [ "null", "string" ], "default": null }, "place": { "type": [ "null", "string" ], "default": null }, "industryCode": { "type": [ "null", "string" ], "default": null }, "registeredDate": { "type": [ "null", "string" ], "format": "date", "default": null }, "employees": { "type": [ "null", "number" ], "format": "double", "default": null }, "revenue": { "type": [ "null", "number" ], "format": "double", "default": null }, "totalAssets": { "type": [ "null", "number" ], "format": "double", "default": null }, "active": { "type": [ "null", "boolean" ], "default": null }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "required": [ "value", "source" ], "type": "object", "properties": { "value": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object", "properties": { "code": { "type": "string", "default": null }, "label": { "type": "string", "default": null }, "oenace": { "type": "string", "default": null }, "lat": { "type": "number", "default": null }, "lng": { "type": "number", "default": null } } } ] }, "source": { "type": "string" }, "asOf": { "type": "string", "format": "date" } } } ] }, "default": null } } }, "MyEntityDto": { "required": [ "id", "name", "lists", "values", "notes", "activity" ], "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ] }, "lists": { "$ref": "#/components/schemas/CursorPageOfEntityListDto" }, "values": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears." }, "notes": { "$ref": "#/components/schemas/CursorPageOfNoteDto" }, "activity": { "$ref": "#/components/schemas/CursorPageOfEntityActivityDto" }, "filledFields": { "type": "integer", "description": "Nonempty own-field values, including zero and false.", "format": "int32", "default": 0 }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/SyncedCell" }, "default": null }, "entryId": { "type": [ "null", "string" ], "default": null } } }, "NetworkNodeType": { "enum": [ "company", "person" ], "type": "string", "description": "Open enum; ignore unknown values." }, "NetworkRelationship": { "enum": [ "assignment", "ownership", "address" ], "type": "string", "description": "Open enum; ignore unknown values." }, "NoteDto": { "required": [ "id", "subject", "text", "at" ], "type": "object", "properties": { "id": { "type": "string" }, "subject": { "$ref": "#/components/schemas/AccountSubject" }, "text": { "type": "string" }, "author": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AccountAuthor" } ] }, "at": { "type": "string", "format": "date-time" }, "editedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "NotificationRulePayload": { "required": [ "channel" ], "type": "object", "properties": { "channel": { "enum": [ "inApp", "email" ], "type": "string" } }, "additionalProperties": false }, "NotificationRulesDto": { "required": [ "inApp", "email" ], "type": "object", "properties": { "inApp": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RuleDto" } ] }, "email": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RuleDto" } ] } } }, "NotificationRuleSetting": { "required": [ "enabled", "id", "revision" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "id": { "type": [ "null", "string" ] }, "revision": { "type": [ "null", "string" ] } }, "additionalProperties": false }, "OwnRecordDto": { "required": [ "id", "name", "match" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "note": { "type": [ "null", "string" ] }, "match": { "$ref": "#/components/schemas/ListEntryMatchDto" }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears.", "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/SyncedCell" }, "default": null } } }, "PersonCompany": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "seat": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanySeat" } ] }, "status": { "type": [ "null", "string" ], "default": null } } }, "PersonFunction": { "required": [ "company", "function", "source" ], "type": "object", "properties": { "company": { "$ref": "#/components/schemas/PersonCompany" }, "function": { "$ref": "#/components/schemas/PersonFunctionCode" }, "since": { "type": [ "null", "string" ], "format": "date" }, "until": { "type": [ "null", "string" ], "format": "date" }, "capital": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CompanyCapital" } ] }, "sharePercent": { "type": [ "null", "number" ], "format": "double" }, "source": { "type": "string" }, "evidence": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RelationshipEvidence" }, "default": null }, "status": { "type": [ "null", "string" ], "default": null } } }, "PersonFunctionCode": { "required": [ "code", "label" ], "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" } } }, "PersonLicense": { "required": [ "gisaNumber", "trade", "role", "holder", "source" ], "type": "object", "properties": { "gisaNumber": { "type": "string" }, "trade": { "$ref": "#/components/schemas/CompanyTrade" }, "role": { "type": "string" }, "holder": { "$ref": "#/components/schemas/CompanyHolder" }, "status": { "type": [ "null", "string" ] }, "source": { "type": "string" }, "description": { "type": [ "null", "string" ], "default": null } } }, "PersonNameEntry": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "PersonPractice": { "required": [ "address" ], "type": "object", "properties": { "address": { "$ref": "#/components/schemas/RegistrationAddress" } } }, "PersonRegistration": { "required": [ "register", "profession", "status", "practice", "source", "lastSeen" ], "type": "object", "properties": { "register": { "type": "string" }, "profession": { "type": "string" }, "status": { "type": "string" }, "practice": { "$ref": "#/components/schemas/PersonPractice" }, "source": { "type": "string" }, "lastSeen": { "type": "string", "format": "date" } } }, "PersonResponse": { "required": [ "name", "id", "type", "identifiers", "formerIds" ], "type": "object", "properties": { "name": { "type": "object", "properties": { "first": { "type": [ "null", "string" ] }, "last": { "type": [ "null", "string" ] }, "titlePrefix": { "type": [ "null", "string" ] }, "titleSuffix": { "type": [ "null", "string" ] } } }, "functionCount": { "type": [ "null", "integer" ], "format": "int32" }, "functions": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonFunction" } ] }, "licenses": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonLicense" } ] }, "notices": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfCompanyNotice" } ] }, "registrations": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfPersonRegistration" } ] }, "id": { "type": "string" }, "type": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } }, "formerIds": { "type": "array", "items": { "type": "string" } }, "changes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CursorPageOfChangeEntry" } ] }, "resolvedFrom": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentifierResolution" } ] } } }, "PersonSearchRequest": { "type": "object", "properties": { "where": { "default": null, "$ref": "#/components/schemas/Filter" }, "q": { "type": [ "null", "string" ], "default": null }, "sort": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PersonSearchSort" } ], "default": null }, "limit": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 25 }, "cursor": { "type": [ "null", "string" ], "default": null }, "filterVersion": { "type": "integer", "format": "int32", "default": 1 } }, "additionalProperties": false }, "PersonSearchSort": { "type": "object", "properties": { "by": { "type": "string", "default": "name" }, "direction": { "type": "string", "default": "asc" } }, "additionalProperties": false }, "PlaceEntry": { "required": [ "type", "code", "label", "zip" ], "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "label": { "type": "string" }, "state": { "type": [ "null", "string" ] }, "zip": { "type": "array", "items": { "type": "string" } }, "slug": { "type": [ "null", "string" ], "default": null }, "aliases": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "companyCount": { "type": [ "null", "integer" ], "format": "int64", "default": null }, "parentCode": { "type": [ "null", "string" ] }, "parentCodes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "geographyId": { "type": [ "null", "string" ] }, "datasetVersion": { "type": [ "null", "string" ] }, "level": { "type": [ "null", "integer" ], "format": "int32" }, "childCount": { "type": [ "null", "integer" ], "format": "int32" }, "refCount": { "type": [ "null", "integer" ], "format": "int64" }, "path": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CatalogPathEntry" } } } }, "Problem": { "required": [ "type", "title", "status", "detail", "code", "requestId", "errors" ], "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "code": { "type": "string" }, "requestId": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/V2ValidationError" } }, "candidates": { "type": [ "null", "array" ], "items": { "type": "string" }, "default": null }, "run": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListRunDto" } ], "default": null } } }, "QueryRulePayload": { "required": [ "definition" ], "type": "object", "properties": { "definition": { "required": [ "subject", "where" ], "type": "object", "properties": { "subject": { "enum": [ "company", "person" ], "type": "string", "description": "Record type: company or person. Automatic list query rules currently support company only." }, "where": { "$ref": "#/components/schemas/Filter" }, "filterVersion": { "enum": [ 1 ], "type": "integer", "description": "Filter language version; use 1.", "format": "int32", "default": 1 } }, "additionalProperties": false } }, "additionalProperties": false }, "ReferenceAddressResponse": { "required": [ "id", "bevCode", "street", "houseNumber", "zip", "city", "country", "active", "geography", "coordinates", "provenance" ], "type": "object", "properties": { "id": { "type": "string" }, "bevCode": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "zip": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "active": { "type": "boolean" }, "geography": { "type": "array", "items": { "$ref": "#/components/schemas/AddressGeographyReference" } }, "coordinates": { "$ref": "#/components/schemas/AddressCoordinatesResponse" }, "provenance": { "$ref": "#/components/schemas/AddressProvenance" } } }, "RegisterIdentifier": { "required": [ "scheme", "value" ], "type": "object", "properties": { "scheme": { "type": "string" }, "value": { "type": "string" }, "source": { "type": [ "null", "string" ] } } }, "RegistrationAddress": { "type": "object", "properties": { "street": { "type": [ "null", "string" ], "default": null }, "zip": { "type": [ "null", "string" ], "default": null }, "city": { "type": [ "null", "string" ], "default": null }, "country": { "type": [ "null", "string" ], "default": null } } }, "RelationshipEvidence": { "required": [ "source" ], "type": "object", "properties": { "source": { "type": "string" }, "sourceUrl": { "type": [ "null", "string" ] }, "observedAt": { "type": [ "null", "string" ], "format": "date-time" }, "entryDate": { "type": [ "null", "string" ], "format": "date" }, "effectiveDate": { "type": [ "null", "string" ], "format": "date" }, "number": { "type": [ "null", "string" ], "default": null }, "subscribedContribution": { "type": [ "null", "number" ], "format": "double", "default": null }, "paidInContribution": { "type": [ "null", "number" ], "format": "double", "default": null }, "currency": { "type": [ "null", "string" ], "default": null } } }, "ReplaceColumnsDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnInput" } } }, "additionalProperties": false }, "ResultField": { "required": [ "path", "type" ], "type": "object", "properties": { "path": { "type": "string" }, "type": { "type": "string" }, "count": { "type": [ "null", "integer" ], "format": "int32" } } }, "ResultSlice": { "required": [ "id", "path", "complete", "fields", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "data": {}, "total": { "type": [ "null", "integer" ], "format": "int32" }, "nextOffset": { "type": [ "null", "integer" ], "format": "int32" }, "complete": { "type": "boolean" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/ResultField" } }, "expiresAt": { "type": "string", "format": "date-time" } } }, "RuleDefinition": { "required": [ "operationId" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/RuleDefinitionApplyListQueryDefinition" }, { "$ref": "#/components/schemas/RuleDefinitionNotifyListEntriesDefinition" } ], "discriminator": { "propertyName": "operationId", "mapping": { "applyListQuery": "#/components/schemas/RuleDefinitionApplyListQueryDefinition", "notifyListEntries": "#/components/schemas/RuleDefinitionNotifyListEntriesDefinition" } } }, "RuleDefinitionApplyListQueryDefinition": { "required": [ "payload", "operationId" ], "properties": { "operationId": { "enum": [ "applyListQuery" ], "type": "string" }, "payload": { "$ref": "#/components/schemas/QueryRulePayload" }, "triggerPayload": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListSchedule" } ], "default": null }, "trigger": { "enum": [ "manual", "schedule" ], "type": "string", "default": "manual" }, "enabled": { "type": "boolean", "default": true }, "schemaVersion": { "enum": [ 1 ], "type": "integer", "format": "int32", "default": 1 } }, "additionalProperties": false }, "RuleDefinitionNotifyListEntriesDefinition": { "required": [ "payload", "operationId" ], "properties": { "operationId": { "enum": [ "notifyListEntries" ], "type": "string" }, "payload": { "$ref": "#/components/schemas/NotificationRulePayload" }, "triggerPayload": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EmptyRuleTrigger" } ], "default": null }, "trigger": { "enum": [ "entry.added" ], "type": "string", "default": "entry.added" }, "enabled": { "type": "boolean", "default": true }, "schemaVersion": { "enum": [ 1 ], "type": "integer", "format": "int32", "default": 1 } }, "additionalProperties": false }, "RuleDto": { "required": [ "id", "listId", "revision", "rule", "credits" ], "type": "object", "properties": { "id": { "type": "string" }, "listId": { "type": "string" }, "revision": { "type": "string" }, "rule": { "$ref": "#/components/schemas/RuleDefinition" }, "nextRunAt": { "type": [ "null", "string" ], "format": "date-time" }, "credits": { "type": "integer", "format": "int32" }, "run": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ListRunDto" } ] } } }, "RuleQuoteDto": { "required": [ "credits", "nextRunAt", "items", "matches", "matchesCapped" ], "type": "object", "properties": { "credits": { "type": "integer", "format": "int32" }, "nextRunAt": { "type": [ "null", "string" ], "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ListEventSubject" } }, "matches": { "type": "integer", "description": "Companies a run would newly add to the list now: matches that are neither members nor excluded, as wouldAdd of a dry run counts them. Counted up to 10000; matchesCapped is true when there are more.", "format": "int32" }, "matchesCapped": { "type": "boolean", "description": "True when more than 10000 companies would be added; matches then reads 10000." } } }, "RunDeliveryDto": { "required": [ "channel", "status" ], "type": "object", "properties": { "channel": { "type": "string" }, "status": { "type": "string" } } }, "RunRuleDto": { "required": [ "revision" ], "type": "object", "properties": { "revision": { "type": "string" }, "dryRun": { "type": "boolean", "default": false } }, "additionalProperties": false }, "SearchIndustry": { "required": [ "oenace" ], "type": "object", "properties": { "oenace": { "type": "string" } } }, "SelectionHandle": { "required": [ "id", "revision", "fingerprint", "count", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "format": "int64" }, "fingerprint": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "SetEntityValuesDto": { "required": [ "values" ], "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears." }, "fields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ContactFieldValue" }, "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Own entries only: values of Firmenakte fields by field catalog path, for example {\"seat.city\": \"Wien\"}; null clears one. A register entry shows the register's values.", "default": null } }, "additionalProperties": false }, "SetNotificationRulesDto": { "required": [ "inApp", "email" ], "type": "object", "properties": { "inApp": { "$ref": "#/components/schemas/NotificationRuleSetting" }, "email": { "$ref": "#/components/schemas/NotificationRuleSetting" } }, "additionalProperties": false }, "SimilarCompany": { "required": [ "id", "name", "reasons" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } } } }, "Stats": { "required": [ "members", "matched", "unmatched", "excluded" ], "type": "object", "properties": { "members": { "type": "integer", "format": "int64" }, "matched": { "type": "integer", "format": "int64" }, "unmatched": { "type": "integer", "format": "int64" }, "excluded": { "type": "integer", "format": "int64" } } }, "StoredResultReference": { "required": [ "id", "operationId", "bytes", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string" }, "operationId": { "type": "string" }, "bytes": { "type": "integer", "format": "int32" }, "expiresAt": { "type": "string", "format": "date-time" } } }, "SyncedCell": { "required": [ "value", "source" ], "type": "object", "properties": { "value": {}, "asOf": { "type": [ "null", "string" ], "format": "date" }, "source": { "type": "string" }, "original": { "default": null }, "availability": { "type": [ "null", "string" ], "default": null }, "overridden": { "type": [ "null", "boolean" ], "default": null } } }, "TopCompany": { "required": [ "id", "name", "location", "identifiers" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "location": { "$ref": "#/components/schemas/TopLocation" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterIdentifier" } }, "legalForm": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CodeLabel" } ] }, "industry": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SearchIndustry" } ] }, "city": { "type": [ "null", "string" ] } } }, "TopGroup": { "required": [ "key", "label" ], "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" } } }, "TopLocation": { "required": [ "lat", "lng" ], "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" } } }, "UidCompanyMatch": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" }, "company": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UidMatchedCompany" } ], "default": null }, "method": { "type": [ "null", "string" ], "default": null }, "assignedAt": { "type": [ "null", "string" ], "format": "date-time", "default": null } } }, "UidMatchedCompany": { "required": [ "id", "fnr", "name" ], "type": "object", "properties": { "id": { "type": "string" }, "fnr": { "type": "string" }, "name": { "type": "string" } } }, "UidVerification": { "required": [ "uid", "status", "verifiedAt", "source", "requestDate" ], "type": "object", "properties": { "uid": { "type": "string" }, "status": { "type": "string" }, "verifiedAt": { "type": "string", "format": "date-time" }, "source": { "type": "string" }, "requestDate": { "type": "string", "format": "date-time" }, "name": { "type": [ "null", "string" ], "default": null }, "address": { "type": [ "null", "string" ], "default": null }, "requestIdentifier": { "type": [ "null", "string" ], "default": null } } }, "UpdateEntryDto": { "type": "object", "properties": { "excluded": { "type": [ "null", "boolean" ], "default": null }, "values": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Workspace field key to a value of its configured type (string, one option, number, ISO date or boolean); null clears.", "default": null }, "sourceValues": { "type": [ "null", "object" ], "additionalProperties": { "oneOf": [ { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Own entries only: values of Firmenakte fields by field catalog path; null clears one.", "default": null } }, "additionalProperties": false }, "UpdateImportDto": { "required": [ "rows" ], "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ImportChoice" } } }, "additionalProperties": false }, "UpdateNoteDto": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" } }, "additionalProperties": false }, "UpdateRuleDto": { "required": [ "revision", "rule" ], "type": "object", "properties": { "revision": { "type": "string" }, "rule": { "$ref": "#/components/schemas/RuleDefinition" } }, "additionalProperties": false }, "V2ValidationError": { "required": [ "code", "detail" ], "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "parameter": { "type": [ "null", "string" ], "default": null }, "pointer": { "type": [ "null", "string" ], "default": null } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "A customer API key. The dashboard may instead use its session cookie.", "name": "x-api-key", "in": "header" } } }, "security": [ { "ApiKey": [] } ], "tags": [ { "name": "public", "summary": "Public", "x-displayName": "Public", "description": "Österreichische Registerdaten finden und auswerten. Authentifizierung und Credits gelten auch für Public." }, { "name": "public.companies", "summary": "Firmen", "x-displayName": "Firmen", "description": "Unternehmen, Firmenbuch, Gesellschaften und Gewerbebetriebe.", "parent": "public" }, { "name": "public.companies.search", "summary": "Suche & Identifikation", "x-displayName": "Suche & Identifikation", "description": "Unternehmen suchen, filtern, auflösen und vergleichen.", "parent": "public.companies" }, { "name": "public.companies.profile", "summary": "Profil & Netzwerk", "x-displayName": "Profil & Netzwerk", "description": "Firmenprofile, Personen, Beziehungen, Standorte und Branchen.", "parent": "public.companies" }, { "name": "public.companies.finances", "summary": "Finanzen", "x-displayName": "Finanzen", "description": "Jahresabschlüsse, Bilanz, Umsatz und Förderungen.", "parent": "public.companies" }, { "name": "public.companies.register", "summary": "Register & Dokumente", "x-displayName": "Register & Dokumente", "description": "Gewerbe, Veröffentlichungen, Firmenbucheinträge und Dokumente herunterladen.", "parent": "public.companies" }, { "name": "public.people", "summary": "Personen", "x-displayName": "Personen", "description": "Personen suchen, Funktionen und Registerbeziehungen lesen.", "parent": "public" }, { "name": "public.catalogs", "summary": "Kataloge", "x-displayName": "Kataloge", "description": "Verfügbare Filterfelder, Branchen, Gewerbe und Ortsbegriffe nachschlagen.", "parent": "public" }, { "name": "public.catalogs.fields", "summary": "Felder & Operatoren", "x-displayName": "Felder & Operatoren", "description": "Filterbare Kennzahlen und Felder mit erlaubten Operatoren und Werten.", "parent": "public.catalogs" }, { "name": "public.catalogs.vocabulary", "summary": "Branchen & Register", "x-displayName": "Branchen & Register", "description": "ÖNACE-Branchen, Gewerbe, Rechtsformen, Funktionen, Gerichte, Kennzahlen und Register.", "parent": "public.catalogs" }, { "name": "public.catalogs.places", "summary": "Orte", "x-displayName": "Orte", "description": "Bundesländer, Gemeinden, Städte, Bezirke und Postleitzahlen suchen.", "parent": "public.catalogs" }, { "name": "public.changes", "summary": "Änderungen", "x-displayName": "Änderungen", "description": "Registeränderungen von Firmen und Personen seit einem gespeicherten Zeitpunkt abrufen.", "parent": "public" }, { "name": "public.search", "summary": "Übergreifende Suche", "x-displayName": "Übergreifende Suche", "description": "Firmen und Personen gemeinsam anhand von Namen oder Kennungen finden.", "parent": "public" }, { "name": "workspace", "summary": "Workspace", "x-displayName": "Workspace", "description": "Eigene Listen und Arbeitsdaten im berechtigten Workspace verwalten." }, { "name": "workspace.lists", "summary": "Listen", "x-displayName": "Listen", "description": "Firmen und Personen sammeln und mit Kriterien sowie Regeln weiterverarbeiten.", "parent": "workspace" }, { "name": "workspace.lists.management", "summary": "Verwaltung", "x-displayName": "Verwaltung", "description": "Listen erstellen, umbenennen, lesen und löschen.", "parent": "workspace.lists" }, { "name": "workspace.lists.entries", "summary": "Einträge & Spalten", "x-displayName": "Einträge & Spalten", "description": "Listeneinträge suchen, hinzufügen, entfernen und sichtbare Spalten bearbeiten.", "parent": "workspace.lists" }, { "name": "workspace.lists.rules", "summary": "Regeln", "x-displayName": "Regeln", "description": "Automatische Abfragen, Suchregeln und Benachrichtigungen erstellen, prüfen, pausieren und ausführen. Recurring, scheduled and automatic query rules add matching companies; notification rules react to new list entries.", "parent": "workspace.lists" }, { "name": "workspace.lists.transfer", "summary": "Import & Export", "x-displayName": "Import & Export", "description": "Importe prüfen und bestätigen; Exportaufträge und Dateien erstellen und abrufen.", "parent": "workspace.lists" }, { "name": "workspace.data", "summary": "Eigene Daten", "x-displayName": "Eigene Daten", "description": "Eigene Datensätze, Feldwerte und Notizen verwalten.", "parent": "workspace" }, { "name": "workspace.data.records", "summary": "Datensätze", "x-displayName": "Datensätze", "description": "Eigene Datensätze und Feldwerte lesen und bearbeiten; Felder mit Werten an Firmen oder eigenen Datensätzen speichern.", "parent": "workspace.data" }, { "name": "workspace.data.fields", "summary": "Felder & Werte", "x-displayName": "Felder & Werte", "description": "Eigene Felddefinitionen und ihre Typen verwalten. Werte an Firmen oder eigenen Datensätzen setzt update_my_entity unter workspace.data.records, auch zusammen mit neuen Feldern.", "parent": "workspace.data" }, { "name": "workspace.data.notes", "summary": "Notizen", "x-displayName": "Notizen", "description": "Notizen zu Firmen und Personen lesen und bearbeiten.", "parent": "workspace.data" }, { "name": "workspace.results", "summary": "Ergebnisse & Auswahlen", "x-displayName": "Ergebnisse & Auswahlen", "description": "Gespeicherte Ergebnisse gezielt lesen und vollständige Auswahlen serverseitig weiterverwenden.", "parent": "workspace" }, { "name": "workspace.access", "summary": "Zugriff & Guthaben", "x-displayName": "Zugriff & Guthaben", "description": "Berechtigten Workspace und verfügbares Guthaben prüfen.", "parent": "workspace" } ], "x-operationCategories": [ { "id": "public", "title": "Public", "description": "Österreichische Registerdaten finden und auswerten. Authentifizierung und Credits gelten auch für Public.", "parent": null }, { "id": "public.companies", "title": "Firmen", "description": "Unternehmen, Firmenbuch, Gesellschaften und Gewerbebetriebe.", "parent": "public" }, { "id": "public.companies.search", "title": "Suche & Identifikation", "description": "Unternehmen suchen, filtern, auflösen und vergleichen.", "parent": "public.companies" }, { "id": "public.companies.profile", "title": "Profil & Netzwerk", "description": "Firmenprofile, Personen, Beziehungen, Standorte und Branchen.", "parent": "public.companies" }, { "id": "public.companies.finances", "title": "Finanzen", "description": "Jahresabschlüsse, Bilanz, Umsatz und Förderungen.", "parent": "public.companies" }, { "id": "public.companies.register", "title": "Register & Dokumente", "description": "Gewerbe, Veröffentlichungen, Firmenbucheinträge und Dokumente herunterladen.", "parent": "public.companies" }, { "id": "public.people", "title": "Personen", "description": "Personen suchen, Funktionen und Registerbeziehungen lesen.", "parent": "public" }, { "id": "public.catalogs", "title": "Kataloge", "description": "Verfügbare Filterfelder, Branchen, Gewerbe und Ortsbegriffe nachschlagen.", "parent": "public" }, { "id": "public.catalogs.fields", "title": "Felder & Operatoren", "description": "Filterbare Kennzahlen und Felder mit erlaubten Operatoren und Werten.", "parent": "public.catalogs" }, { "id": "public.catalogs.vocabulary", "title": "Branchen & Register", "description": "ÖNACE-Branchen, Gewerbe, Rechtsformen, Funktionen, Gerichte, Kennzahlen und Register.", "parent": "public.catalogs" }, { "id": "public.catalogs.places", "title": "Orte", "description": "Bundesländer, Gemeinden, Städte, Bezirke und Postleitzahlen suchen.", "parent": "public.catalogs" }, { "id": "public.changes", "title": "Änderungen", "description": "Registeränderungen von Firmen und Personen seit einem gespeicherten Zeitpunkt abrufen.", "parent": "public" }, { "id": "public.search", "title": "Übergreifende Suche", "description": "Firmen und Personen gemeinsam anhand von Namen oder Kennungen finden.", "parent": "public" }, { "id": "workspace", "title": "Workspace", "description": "Eigene Listen und Arbeitsdaten im berechtigten Workspace verwalten.", "parent": null }, { "id": "workspace.lists", "title": "Listen", "description": "Firmen und Personen sammeln und mit Kriterien sowie Regeln weiterverarbeiten.", "parent": "workspace" }, { "id": "workspace.lists.management", "title": "Verwaltung", "description": "Listen erstellen, umbenennen, lesen und löschen.", "parent": "workspace.lists" }, { "id": "workspace.lists.entries", "title": "Einträge & Spalten", "description": "Listeneinträge suchen, hinzufügen, entfernen und sichtbare Spalten bearbeiten.", "parent": "workspace.lists" }, { "id": "workspace.lists.rules", "title": "Regeln", "description": "Automatische Abfragen, Suchregeln und Benachrichtigungen erstellen, prüfen, pausieren und ausführen. Recurring, scheduled and automatic query rules add matching companies; notification rules react to new list entries.", "parent": "workspace.lists" }, { "id": "workspace.lists.transfer", "title": "Import & Export", "description": "Importe prüfen und bestätigen; Exportaufträge und Dateien erstellen und abrufen.", "parent": "workspace.lists" }, { "id": "workspace.data", "title": "Eigene Daten", "description": "Eigene Datensätze, Feldwerte und Notizen verwalten.", "parent": "workspace" }, { "id": "workspace.data.records", "title": "Datensätze", "description": "Eigene Datensätze und Feldwerte lesen und bearbeiten; Felder mit Werten an Firmen oder eigenen Datensätzen speichern.", "parent": "workspace.data" }, { "id": "workspace.data.fields", "title": "Felder & Werte", "description": "Eigene Felddefinitionen und ihre Typen verwalten. Werte an Firmen oder eigenen Datensätzen setzt update_my_entity unter workspace.data.records, auch zusammen mit neuen Feldern.", "parent": "workspace.data" }, { "id": "workspace.data.notes", "title": "Notizen", "description": "Notizen zu Firmen und Personen lesen und bearbeiten.", "parent": "workspace.data" }, { "id": "workspace.results", "title": "Ergebnisse & Auswahlen", "description": "Gespeicherte Ergebnisse gezielt lesen und vollständige Auswahlen serverseitig weiterverwenden.", "parent": "workspace" }, { "id": "workspace.access", "title": "Zugriff & Guthaben", "description": "Berechtigten Workspace und verfügbares Guthaben prüfen.", "parent": "workspace" } ] }