Connections to external systems (accounting, CRM, payment and other providers): connect, configure, pause and resume an integration, run its sync or actions, and read the external objects it created and its activity log.
List every integration with its status
The integrations catalog: every connector the platform offers — available, planned or configured on its own settings page — with this workspace's connection status, measured health (healthy, failing or unchecked; never assumed) and any unmet prerequisite.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List every integration with its status › Responses
OK
List external objects created by integrations
Which object an integration created for a Kontier record (a voucher in Lexoffice for an invoice, a partner in Odoo for a customer), with a link to it in the vendor's own application where one exists.
query Parameters
connectorOnly links of this integration.
entity_kindOnly links of this kind of object.
entity_idOnly links of this object.
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List external objects created by integrations › Responses
OK
List integration activity
What integrations did: probes, syncs, delivered events, actions and inbound callbacks, newest first. Filter by integration, by the object a run was about, or by status.
query Parameters
connectorOnly runs of this integration.
entity_kindOnly runs about this kind of object (invoice, credit_note, customer).
entity_idOnly runs about this object.
statusOnly runs with this status.
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
beforeOnly runs started before this RFC 3339 instant (paging).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List integration activity › Responses
OK
Get one integration
One integration's descriptor, connection, health, settings (secrets as masked hints only) and last run.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get one integration › Responses
OK
Connect an integration
Creates this workspace's connection. Values are validated against the integration's fields; secret fields are stored sealed and never returned. With verify=true the vendor is probed before answering; a failed probe still saves the connection, marked failing, so the vendor side can be fixed without retyping.
path Parameters
slugHeaders
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Connect an integration › Request Body
Field values keyed by the descriptor's field keys. A secret field left empty on update keeps the stored value.
enabledWhether the connection is active. Defaults to true on connect.
verifyProbe the vendor before answering. A failed probe still saves the connection, marked failing.
Connect an integration › Responses
Created
Disconnect an integration
Removes the connection and its credentials. Links to external objects and the activity history are kept, read-only.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Disconnect an integration › Responses
No Content
Change an integration's settings or rotate its credentials
Changes settings and/or replaces secrets in place: the connection id, and therefore any callback address registered at the vendor, stays the same. A secret left empty keeps the stored one. Replacing a secret re-probes the vendor.
path Parameters
slugHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Change an integration's settings or rotate its credentials › Request Body
Field values keyed by the descriptor's field keys. A secret field left empty on update keeps the stored value.
enabledWhether the connection is active. Defaults to true on connect.
verifyProbe the vendor before answering. A failed probe still saves the connection, marked failing.
Change an integration's settings or rotate its credentials › Responses
OK
Run one of an integration's actions
Runs a named action from the integration's descriptor (generate a return, backfill, look up a participant …). An action that produces a file answers with the file as an attachment and its run id in X-Integration-Run; any other answers with JSON {run, summary, data}.
path Parameters
slugactionAction key from the descriptor's actions.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Run one of an integration's actions › Request Body
The action's parameters, keyed by the action's param keys.
Run one of an integration's actions › Responses
OK
Preview what disconnecting would stop
Counts what a disconnect stops (scheduled syncs, delivered event types, the vendor's callback address) and what it keeps (links and history).
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Preview what disconnecting would stop › Responses
OK
Start an integration's OAuth authorization
Answers with the vendor's authorization URL to send the operator to. The vendor redirects back to the API, which stores the tokens and lands the operator on the integration's page.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Start an integration's OAuth authorization › Responses
OK
Pause an integration
Stops its syncs, deliveries and callbacks. Configuration, links and history stay.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Pause an integration › Responses
OK
Resume a paused integration
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Resume a paused integration › Responses
OK
Run an integration's sync now
Runs the sync once and answers with its run. One run per connection at a time: a second request while one runs is refused with 409.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Run an integration's sync now › Responses
OK
Test an integration's connection now
Probes the vendor with the stored credentials and records the result as the connection's health.
path Parameters
slugIntegration slug, e.g. lexoffice.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Test an integration's connection now › Responses
OK