Organización y configuración

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

Esta referencia se genera a partir del esquema de la API. Las descripciones de los campos y cualquier texto aún sin traducir se muestran en inglés.

Organización

Endpoints

Organización: Endpoints
MétodoRuta
GET/organizations
POST/organizations
GET/organizations/{id}
POST/organizations/clear
POST/organizations/icon
POST/organizations/logo
GET/organizations/mail-footer
PATCH/organizations/mail-footer

Campos de schema

Organización: Campos de schema
CampoTipo
idstring
typestring
statusstring
namestring
slugstring
stripeCustomerIdstringnull
manualBillingboolean
databaseStatusarraynull
verifiedboolean
verifiedAtstring,null (date-time)
verifiedBystringnull
verificationRequestedAtstring,null (date-time)
graceStartedAtstring,null (date-time)
obsoletedAtstring,null (date-time)
purgedAtstring,null (date-time)
organizationUsersarray
organizationUserInvitationsarray
organizationModulesarray
subscriptionsarray
organizationConfigsarray
organizationAddressesarray
createdAtstring (date-time)
updatedAtstring (date-time)
demoboolean
productionLikeboolean
excludedFromSchemaCommandsboolean
currentSubscriptionstring,null (iri-reference)
establishedPaymentboolean
trustedboolean

Ubicación

Endpoints

Ubicación: Endpoints
MétodoRuta
GET/locations
POST/locations
GET/locations/{id}
PATCH/locations/{id}

Campos de schema

Ubicación: Campos de schema
CampoTipo
name*string
officeOpenHourintegernull
officeCloseHourintegernull

País

Endpoints

País: Endpoints
MétodoRuta
GET/countries
GET/countries/{id}

Campos de schema

País: Campos de schema
CampoTipo
id*string

Idioma

Endpoints

Idioma: Endpoints
MétodoRuta
GET/languages
POST/languages
GET/languages/{id}

Campos de schema

Idioma: Campos de schema
CampoTipo
id*string

Integración

Endpoints

Integración: Endpoints
MétodoRuta
POST/integrations/kontomatik/pull
POST/integrations/kontomatik/revoke
POST/integrations/kontomatik/setup

Reunión

Endpoints

Reunión: Endpoints
MétodoRuta
GET/meetings
POST/meetings
GET/meetings/{id}
PATCH/meetings/{id}

Campos de schema

Reunión: Campos de schema
CampoTipo
employee*string,null (iri-reference)
dateFrom*string (date-time)
dateTo*string (date-time)
notesstringnull
timestring,null (date-time)

Suscripción

Endpoints

Suscripción: Endpoints
MétodoRuta
GET/subscriptions
POST/subscriptions
GET/subscriptions/{id}
POST/subscriptions/{id}/cancel
GET/subscriptions/{id}/invoices
POST/subscriptions/apply-coupon
POST/subscriptions/clear-coupon

Campos de schema

Suscripción: Campos de schema
CampoTipo
idstring
organizationstring (iri-reference)
organizationAddressstring (iri-reference)
typestring
paymentMethodstring,null (iri-reference)
productsarray
seatsinteger
modulesarray
statusstring
externalIdstringnull
metadataarray
createdAtstring (date-time)
updatedAtstring (date-time)
activeboolean
awaitingboolean

Dirección de la Organización

Endpoints

Dirección de la Organización: Endpoints
MétodoRuta
GET/organization-addresses
POST/organization-addresses
GET/organization-addresses/{id}
PATCH/organization-addresses/{id}
DELETE/organization-addresses/{id}

Campos de schema

Dirección de la Organización: Campos de schema
CampoTipo
type*string
name*string
street*string
city*string
postCode*string
country*string
emailstring,null (email)
tinstringnull
tinCountrystringnull

Configuración de la Organización

Endpoints

Configuración de la Organización: Endpoints
MétodoRuta
GET/configs
GET/configs/{id}
PATCH/configs/{id}

Campos de schema

Configuración de la Organización: Campos de schema
CampoTipo
type*string
name*string

Usuario de la Organización

Endpoints

Usuario de la Organización: Endpoints
MétodoRuta
GET/organization-users
DELETE/organization-users/{id}

Campos de schema

Usuario de la Organización: Campos de schema
CampoTipo
idstring
organizationstring (iri-reference)
userstring (iri-reference)
typestring
organizationUserConfigsarray
createdAtstring (date-time)
updatedAtstring (date-time)

Configuración del Usuario de la Organización

Endpoints

Configuración del Usuario de la Organización: Endpoints
MétodoRuta
GET/user-configs/{id}
PATCH/user-configs/{id}

Campos de schema

Configuración del Usuario de la Organización: Campos de schema
CampoTipo
typestring
namestring
valuestring

Invitación de Usuario de la Organización

Endpoints

Invitación de Usuario de la Organización: Endpoints
MétodoRuta
GET/organization-user-invitations
POST/organization-user-invitations/{id}/accept
POST/organization-user-invitations/{id}/reject
POST/organization-user-invitations/{id}/retry

Campos de schema

Invitación de Usuario de la Organización: Campos de schema
CampoTipo
idstring
organizationstring (iri-reference)
employeeIdstring
userstring,null (iri-reference)
emailstring
firstnamestring
lastnamestring
statusstring
phonestringnull
createdAtstring (date-time)
updatedAtstring (date-time)
deletedAtstring,null (date-time)
fullnamestring
deletedboolean

Elemento del Catálogo de Claves de Configuración

Endpoints

Elemento del Catálogo de Claves de Configuración: Endpoints
MétodoRuta
GET/config-keys

Campos de schema

Elemento del Catálogo de Claves de Configuración: Campos de schema
CampoTipo
namestring
typestring
groupstring
labelstring
descriptionstring
defaultValuestring
allowedValuesarray
writableboolean