Organización y configuración

Organización, ubicaciones, usuarios, integraciones y suscripción — configura el espacio de trabajo.

Organización

Endpoints

GET	/organizations	Recupera la colección de recursos Organization.
POST	/organizations	Crea un recurso Organization.
GET	/organizations/{id}	Recupera un recurso Organization.
POST	/organizations/clear	Crea un recurso Organization.
POST	/organizations/icon	Crea un recurso Organization.
POST	/organizations/logo	Crea un recurso Organization.
GET	/organizations/mail-footer	Recupera un recurso Organization.
PATCH	/organizations/mail-footer	Actualiza el recurso Organization.

Campos de schema

Campo	Tipo	Descripción
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)

Ubicación

Endpoints

GET	/locations	Recupera la colección de recursos Location.
POST	/locations	Crea un recurso Location.
GET	/locations/{id}	Recupera un recurso Location.
PATCH	/locations/{id}	Actualiza el recurso Location.

Campos de schema

Campo	Tipo	Descripción
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

País

Endpoints

GET	/countries	Recupera la colección de recursos Country.
GET	/countries/{id}	Recupera un recurso Country.

Campos de schema

Campo	Tipo	Descripción
id*	string

Idioma

Endpoints

GET	/languages	Recupera la colección de recursos Language.
POST	/languages	Crea un recurso Language.
GET	/languages/{id}	Recupera un recurso Language.

Campos de schema

Campo	Tipo	Descripción
id*	string

Integración

Endpoints

POST	/integrations/kontomatik/pull	Crea un recurso Integration.
POST	/integrations/kontomatik/revoke	Crea un recurso Integration.
POST	/integrations/kontomatik/setup	Crea un recurso Integration.

Reunión

Endpoints

GET	/meetings	Recupera la colección de recursos Meeting.
POST	/meetings	Crea un recurso Meeting.
GET	/meetings/{id}	Recupera un recurso Meeting.
PATCH	/meetings/{id}	Actualiza el recurso Meeting.

Campos de schema

Campo	Tipo	Descripción
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Suscripción

Endpoints

GET	/subscriptions	Recupera la colección de recursos Subscription.
POST	/subscriptions	Crea un recurso Subscription.
GET	/subscriptions/{id}	Recupera un recurso Subscription.
POST	/subscriptions/{id}/cancel	Crea un recurso Subscription.
GET	/subscriptions/{id}/invoices	Recupera la colección de recursos Subscription.
POST	/subscriptions/apply-coupon	Crea un recurso Subscription.
POST	/subscriptions/clear-coupon	Crea un recurso Subscription.

Campos de schema

Campo	Tipo	Descripción
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

Dirección de la Organización

Endpoints

GET	/organization-addresses	Recupera la colección de recursos OrganizationAddress.
POST	/organization-addresses	Crea un recurso OrganizationAddress.
GET	/organization-addresses/{id}	Recupera un recurso OrganizationAddress.
PATCH	/organization-addresses/{id}	Actualiza el recurso OrganizationAddress.
DELETE	/organization-addresses/{id}	Elimina el recurso OrganizationAddress.

Campos de schema

Campo	Tipo	Descripción
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Configuración de la Organización

Endpoints

GET	/configs	Get multiple configuration values
GET	/configs/{id}	Recupera un recurso OrganizationConfig.
PATCH	/configs/{id}	Actualiza el recurso OrganizationConfig.

Campos de schema

Campo	Tipo	Descripción
type*	string
name*	string

Usuario de la Organización

Endpoints

GET	/organization-users	Recupera la colección de recursos OrganizationUser.
DELETE	/organization-users/{id}	Elimina el recurso OrganizationUser.

Campos de schema

Campo	Tipo	Descripción
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Configuración del Usuario de la Organización

Endpoints

GET	/user-configs/{id}	Recupera un recurso OrganizationUserConfig.
PATCH	/user-configs/{id}	Actualiza el recurso OrganizationUserConfig.

Campos de schema

Campo	Tipo	Descripción
type	string
name	string
value	string

Invitación de Usuario de la Organización

Endpoints

GET	/organization-user-invitations	Recupera la colección de recursos OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/accept	Crea un recurso OrganizationUserInvitation.
POST	/organization-user-invitations/{id}/reject	Crea un recurso OrganizationUserInvitation.

Campos de schema

Campo	Tipo	Descripción
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.

Elemento del Catálogo de Claves de Configuración

Endpoints

GET

/config-keys

Campos de schema

Campo	Tipo	Descripción
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.