Organisation & configuration

Organisation, emplacements, intégrations et abonnement — configurez votre 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
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)

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