Organisation & configuration

Organisation, sites, utilisateurs, intégrations et abonnement — configurez l'espace de travail.

Organisation

Points de terminaison

GET	/organizations	Récupère la collection de ressources Organization.
POST	/organizations	Crée une ressource Organization.
GET	/organizations/{id}	Récupère une ressource Organization.
POST	/organizations/clear	Crée une ressource Organization.
POST	/organizations/icon	Crée une ressource Organization.
POST	/organizations/logo	Crée une ressource Organization.
GET	/organizations/mail-footer	Récupère une ressource Organization.
PATCH	/organizations/mail-footer	Met à jour la ressource Organization.

Champs de schéma

Champ	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)
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)
establishedPayment	boolean
trusted	boolean

Emplacement

Points de terminaison

GET	/locations	Récupère la collection de ressources Location.
POST	/locations	Crée une ressource Location.
GET	/locations/{id}	Récupère une ressource Location.
PATCH	/locations/{id}	Met à jour la ressource Location.

Champs de schéma

Champ	Type	Description
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Pays

Points de terminaison

GET	/countries	Récupère la collection de ressources Country.
GET	/countries/{id}	Récupère une ressource Country.

Champs de schéma

Champ	Type	Description
id*	string

Langue

Points de terminaison

GET	/languages	Récupère la collection de ressources Language.
POST	/languages	Crée une ressource Language.
GET	/languages/{id}	Récupère une ressource Language.

Champs de schéma

Champ	Type	Description
id*	string

Intégration

Points de terminaison

POST	/integrations/kontomatik/pull	Crée une ressource Integration.
POST	/integrations/kontomatik/revoke	Crée une ressource Integration.
POST	/integrations/kontomatik/setup	Crée une ressource Integration.

Réunion

Points de terminaison

GET	/meetings	Récupère la collection de ressources Meeting.
POST	/meetings	Crée une ressource Meeting.
GET	/meetings/{id}	Récupère une ressource Meeting.
PATCH	/meetings/{id}	Met à jour la ressource Meeting.

Champs de schéma

Champ	Type	Description
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Abonnement

Points de terminaison

GET	/subscriptions	Récupère la collection de ressources Subscription.
POST	/subscriptions	Crée une ressource Subscription.
GET	/subscriptions/{id}	Récupère une ressource Subscription.
POST	/subscriptions/{id}/cancel	Crée une ressource Subscription.
GET	/subscriptions/{id}/invoices	Récupère la collection de ressources Subscription.
POST	/subscriptions/apply-coupon	Crée une ressource Subscription.
POST	/subscriptions/clear-coupon	Crée une ressource Subscription.

Champs de schéma

Champ	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

Adresse de l'organisation

Points de terminaison

GET	/organization-addresses	Récupère la collection de ressources OrganizationAddress.
POST	/organization-addresses	Crée une ressource OrganizationAddress.
GET	/organization-addresses/{id}	Récupère une ressource OrganizationAddress.
PATCH	/organization-addresses/{id}	Met à jour la ressource OrganizationAddress.
DELETE	/organization-addresses/{id}	Supprime la ressource OrganizationAddress.

Champs de schéma

Champ	Type	Description
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Configuration de l'organisation

Points de terminaison

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Récupère une ressource OrganizationConfig.
PATCH	/configs/{id}	Met à jour la ressource OrganizationConfig.

Champs de schéma

Champ	Type	Description
type*	string
name*	string

Utilisateur de l'organisation

Points de terminaison

GET	/organization-users	Récupère la collection de ressources OrganizationUser.
DELETE	/organization-users/{id}	Supprime la ressource OrganizationUser.

Champs de schéma

Champ	Type	Description
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Configuration utilisateur de l'organisation

Points de terminaison

GET	/user-configs/{id}	Récupère une ressource OrganizationUserConfig.
PATCH	/user-configs/{id}	Met à jour la ressource OrganizationUserConfig.

Champs de schéma

Champ	Type	Description
type	string
name	string
value	string

Invitation utilisateur de l'organisation

Points de terminaison

GET	/organization-user-invitations	Récupère la collection de ressources OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/accept	Crée une ressource OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/reject	Crée une ressource OrganizationUserInvitation.

Champs de schéma

Champ	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.

Élément du catalogue de clés de configuration

Points de terminaison

GET

/config-keys

Champs de schéma

Champ	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.