Organization & config

Organization, locations, users, integrations and subscription — configure the workspace.

Organization

Endpoints

Organization: Endpoints
Method	Path	Description
GET	/organizations	Retrieves the collection of Organization resources.
POST	/organizations	Creates a Organization resource.
GET	/organizations/{id}	Retrieves a Organization resource.
POST	/organizations/clear	Creates a Organization resource.
POST	/organizations/icon	Creates a Organization resource.
POST	/organizations/logo	Creates a Organization resource.
GET	/organizations/mail-footer	Retrieves a Organization resource.
PATCH	/organizations/mail-footer	Updates the Organization resource.

Schema fields

Organization: Schema fields
Field	Type	Description
id	string
type	string
status	string
name	string
slug	string
stripeCustomerId	stringnull
manualBilling	boolean
databaseStatus	arraynull
verified	boolean
verifiedAt	string,null (date-time)
verifiedBy	stringnull
verificationRequestedAt	string,null (date-time)
graceStartedAt	string,null (date-time)
obsoletedAt	string,null (date-time)
purgedAt	string,null (date-time)	When the tenant schema was destroyed. NULL until the purge, set once, never cleared.
organizationUsers	array
organizationUserInvitations	array
organizationModules	array
subscriptions	array
organizationConfigs	array
organizationAddresses	array
createdAt	string (date-time)
updatedAt	string (date-time)
demo	boolean
productionLike	boolean
excludedFromSchemaCommands	boolean	Whether a schema-touching command will REFUSE this organization.
currentSubscription	string,null (iri-reference)
establishedPayment	boolean
trusted	boolean

Location

Endpoints

Location: Endpoints
Method	Path	Description
GET	/locations	Retrieves the collection of Location resources.
POST	/locations	Creates a Location resource.
GET	/locations/{id}	Retrieves a Location resource.
PATCH	/locations/{id}	Updates the Location resource.

Schema fields

Location: Schema fields
Field	Type	Description
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Country

Endpoints

Country: Endpoints
Method	Path	Description
GET	/countries	Retrieves the collection of Country resources.
GET	/countries/{id}	Retrieves a Country resource.

Schema fields

Country: Schema fields
Field	Type	Description
id*	string

Language

Endpoints

Language: Endpoints
Method	Path	Description
GET	/languages	Retrieves the collection of Language resources.
POST	/languages	Creates a Language resource.
GET	/languages/{id}	Retrieves a Language resource.

Schema fields

Language: Schema fields
Field	Type	Description
id*	string

Integration

Endpoints

Integration: Endpoints
Method	Path	Description
POST	/integrations/kontomatik/pull	Creates a Integration resource.
POST	/integrations/kontomatik/revoke	Creates a Integration resource.
POST	/integrations/kontomatik/setup	Creates a Integration resource.

Meeting

Endpoints

Meeting: Endpoints
Method	Path	Description
GET	/meetings	Retrieves the collection of Meeting resources.
POST	/meetings	Creates a Meeting resource.
GET	/meetings/{id}	Retrieves a Meeting resource.
PATCH	/meetings/{id}	Updates the Meeting resource.

Schema fields

Meeting: Schema fields
Field	Type	Description
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Subscription

Endpoints

Subscription: Endpoints
Method	Path	Description
GET	/subscriptions	Retrieves the collection of Subscription resources.
POST	/subscriptions	Creates a Subscription resource.
GET	/subscriptions/{id}	Retrieves a Subscription resource.
POST	/subscriptions/{id}/cancel	Creates a Subscription resource.
GET	/subscriptions/{id}/invoices	Retrieves the collection of Subscription resources.
POST	/subscriptions/apply-coupon	Creates a Subscription resource.
POST	/subscriptions/clear-coupon	Creates a Subscription resource.

Schema fields

Subscription: Schema fields
Field	Type	Description
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

Organization Address

Endpoints

Organization Address: Endpoints
Method	Path	Description
GET	/organization-addresses	Retrieves the collection of OrganizationAddress resources.
POST	/organization-addresses	Creates a OrganizationAddress resource.
GET	/organization-addresses/{id}	Retrieves a OrganizationAddress resource.
PATCH	/organization-addresses/{id}	Updates the OrganizationAddress resource.
DELETE	/organization-addresses/{id}	Removes the OrganizationAddress resource.

Schema fields

Organization Address: Schema fields
Field	Type	Description
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Organization Config

Endpoints

Organization Config: Endpoints
Method	Path	Description
GET	/configs	Get multiple configuration values
GET	/configs/{id}	Retrieves a OrganizationConfig resource.
PATCH	/configs/{id}	Updates the OrganizationConfig resource.

Schema fields

Organization Config: Schema fields
Field	Type	Description
type*	string
name*	string

Organization User

Endpoints

Organization User: Endpoints
Method	Path	Description
GET	/organization-users	Retrieves the collection of OrganizationUser resources.
DELETE	/organization-users/{id}	Removes the OrganizationUser resource.

Schema fields

Organization User: Schema fields
Field	Type	Description
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Organization User Config

Endpoints

Organization User Config: Endpoints
Method	Path	Description
GET	/user-configs/{id}	Retrieves a OrganizationUserConfig resource.
PATCH	/user-configs/{id}	Updates the OrganizationUserConfig resource.

Schema fields

Organization User Config: Schema fields
Field	Type	Description
type	string
name	string
value	string

Organization User Invitation

Endpoints

Organization User Invitation: Endpoints
Method	Path	Description
GET	/organization-user-invitations	Retrieves the collection of OrganizationUserInvitation resources.
POST	/organization-user-invitations/{id}/accept	Creates a OrganizationUserInvitation resource.
POST	/organization-user-invitations/{id}/reject	Creates a OrganizationUserInvitation resource.
POST	/organization-user-invitations/{id}/retry	Creates a OrganizationUserInvitation resource.

Schema fields

Organization User Invitation: Schema fields
Field	Type	Description
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.

Config Key Catalog Item

Endpoints

Config Key Catalog Item: Endpoints
Method	Path	Description
GET	/config-keys	Retrieves the collection of ConfigKeyCatalogItem resources.

Schema fields

Config Key Catalog Item: Schema fields
Field	Type	Description
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.