Organisation & Konfiguration

Organisation, Standorte, Benutzer, Integrationen und Abonnement — konfigurieren Sie den Arbeitsbereich.

Organisation

Endpoints

GET	/organizations	Ruft die Sammlung der Organization-Ressourcen ab.
POST	/organizations	Erstellt eine Organization-Ressource.
GET	/organizations/{id}	Ruft eine Organization-Ressource ab.
POST	/organizations/clear	Erstellt eine Organization-Ressource.
POST	/organizations/icon	Erstellt eine Organization-Ressource.
POST	/organizations/logo	Erstellt eine Organization-Ressource.
GET	/organizations/mail-footer	Ruft eine Organization-Ressource ab.
PATCH	/organizations/mail-footer	Aktualisiert die Organization-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
type	string
status	string
name	string
slug	string
stripeCustomerId	stringnull
manualBilling	boolean
databaseStatus	arraynull
organizationUsers	array
organizationUserInvitations	array
organizationModules	array
subscriptions	array
organizationConfigs	array
organizationAddresses	array
createdAt	string (date-time)
updatedAt	string (date-time)
demo	boolean
productionLike	boolean
currentSubscription	string,null (iri-reference)

Standort

Endpoints

GET	/locations	Ruft die Sammlung der Location-Ressourcen ab.
POST	/locations	Erstellt eine Location-Ressource.
GET	/locations/{id}	Ruft eine Location-Ressource ab.
PATCH	/locations/{id}	Aktualisiert die Location-Ressource.

Schemafelder

Feld	Typ	Beschreibung
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Land

Endpoints

GET	/countries	Ruft die Sammlung der Country-Ressourcen ab.
GET	/countries/{id}	Ruft eine Country-Ressource ab.

Schemafelder

Feld	Typ	Beschreibung
id*	string

Sprache

Endpoints

GET	/languages	Ruft die Sammlung der Language-Ressourcen ab.
POST	/languages	Erstellt eine Language-Ressource.
GET	/languages/{id}	Ruft eine Language-Ressource ab.

Schemafelder

Feld	Typ	Beschreibung
id*	string

Integration

Endpoints

POST	/integrations/kontomatik/pull	Erstellt eine Integration-Ressource.
POST	/integrations/kontomatik/revoke	Erstellt eine Integration-Ressource.
POST	/integrations/kontomatik/setup	Erstellt eine Integration-Ressource.

Meeting

Endpoints

GET	/meetings	Ruft die Sammlung der Meeting-Ressourcen ab.
POST	/meetings	Erstellt eine Meeting-Ressource.
GET	/meetings/{id}	Ruft eine Meeting-Ressource ab.
PATCH	/meetings/{id}	Aktualisiert die Meeting-Ressource.

Schemafelder

Feld	Typ	Beschreibung
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Abonnement

Endpoints

GET	/subscriptions	Ruft die Sammlung der Subscription-Ressourcen ab.
POST	/subscriptions	Erstellt eine Subscription-Ressource.
GET	/subscriptions/{id}	Ruft eine Subscription-Ressource ab.
POST	/subscriptions/{id}/cancel	Erstellt eine Subscription-Ressource.
GET	/subscriptions/{id}/invoices	Ruft die Sammlung der Subscription-Ressourcen ab.
POST	/subscriptions/apply-coupon	Erstellt eine Subscription-Ressource.
POST	/subscriptions/clear-coupon	Erstellt eine Subscription-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
organization	string (iri-reference)
organizationAddress	string (iri-reference)
type	string
paymentMethod	string,null (iri-reference)
products	array
seats	integer
modules	array
status	string
externalId	stringnull
metadata	array
createdAt	string (date-time)
updatedAt	string (date-time)
active	boolean
awaiting	boolean

Organisationsadresse

Endpoints

GET	/organization-addresses	Ruft die Sammlung der OrganizationAddress-Ressourcen ab.
POST	/organization-addresses	Erstellt eine OrganizationAddress-Ressource.
GET	/organization-addresses/{id}	Ruft eine OrganizationAddress-Ressource ab.
PATCH	/organization-addresses/{id}	Aktualisiert die OrganizationAddress-Ressource.
DELETE	/organization-addresses/{id}	Entfernt die OrganizationAddress-Ressource.

Schemafelder

Feld	Typ	Beschreibung
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Organisationskonfiguration

Endpoints

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Ruft eine OrganizationConfig-Ressource ab.
PATCH	/configs/{id}	Aktualisiert die OrganizationConfig-Ressource.

Schemafelder

Feld	Typ	Beschreibung
type*	string
name*	string

Organisationsbenutzer

Endpoints

GET	/organization-users	Ruft die Sammlung der OrganizationUser-Ressourcen ab.
DELETE	/organization-users/{id}	Entfernt die OrganizationUser-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Konfiguration des Organisationsbenutzers

Endpoints

GET	/user-configs/{id}	Ruft eine OrganizationUserConfig-Ressource ab.
PATCH	/user-configs/{id}	Aktualisiert die OrganizationUserConfig-Ressource.

Schemafelder

Feld	Typ	Beschreibung
type	string
name	string
value	string

Einladung des Organisationsbenutzers

Endpoints

GET	/organization-user-invitations	Ruft die Sammlung der OrganizationUserInvitation-Ressourcen ab.
POST	/organization-user-invitations/{id}/accept	Erstellt eine OrganizationUserInvitation-Ressource.
POST	/organization-user-invitations/{id}/reject	Erstellt eine OrganizationUserInvitation-Ressource.

Schemafelder

Feld	Typ	Beschreibung
id	string
organization	string (iri-reference)
employeeId	string
user	string,null (iri-reference)
email	string
firstname	string
lastname	string
status	string
phone	stringnull
createdAt	string (date-time)
updatedAt	string (date-time)
deletedAt	string,null (date-time)
fullname	string
deleted	boolean	Check if the entity has been soft deleted.

Katalogeintrag für Konfigurationsschlüssel

Endpoints

GET

/config-keys

Schemafelder

Feld	Typ	Beschreibung
name	string	The config key slug — the id used at /configs/{name}.
type	string	Value type: boolean\|string\|option\|datetime\|number\|integer\|array.
group	string	Grouping derived from the key namespace, e.g. "Organization", "Invoice".
label	string	Human-readable label (falls back to a humanized slug when undocumented).
description	string	What the setting controls and the impact of changing it ('' if undocumented).
defaultValue	string	The default value applied when the org hasn't set one.
allowedValues	array	Allowed values for `option`-type settings (parsed from the key's Choice constraint); empty for free-form types.
writable	boolean	Whether the current caller is permitted to change this setting.