Organisation & konfiguration

Organisation, platser, användare, integrationer och prenumeration — konfigurera arbetsytan.

Den här referensen genereras från API-schemat. Fältbeskrivningar och text som ännu inte är översatt visas på engelska.

Organisation

Endpoints

Organisation: Endpoints
Metod	Sökväg	Beskrivning
GET	/organizations	Hämtar samlingen av Organization-resurser.
POST	/organizations	Skapar en Organization-resurs.
GET	/organizations/{id}	Hämtar en Organization-resurs.
POST	/organizations/clear	Skapar en Organization-resurs.
POST	/organizations/icon	Skapar en Organization-resurs.
POST	/organizations/logo	Skapar en Organization-resurs.
GET	/organizations/mail-footer	Hämtar en Organization-resurs.
PATCH	/organizations/mail-footer	Uppdaterar Organization-resursen.

Schema-fält

Organisation: Schema-fält
Fält	Typ	Beskrivning
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

Plats

Endpoints

Plats: Endpoints
Metod	Sökväg	Beskrivning
GET	/locations	Hämtar samlingen av Location-resurser.
POST	/locations	Skapar en Location-resurs.
GET	/locations/{id}	Hämtar en Location-resurs.
PATCH	/locations/{id}	Uppdaterar Location-resursen.

Schema-fält

Plats: Schema-fält
Fält	Typ	Beskrivning
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

Land

Endpoints

Land: Endpoints
Metod	Sökväg	Beskrivning
GET	/countries	Hämtar samlingen av Country-resurser.
GET	/countries/{id}	Hämtar en Country-resurs.

Schema-fält

Land: Schema-fält
Fält	Typ	Beskrivning
id*	string

Språk

Endpoints

Språk: Endpoints
Metod	Sökväg	Beskrivning
GET	/languages	Hämtar samlingen av Language-resurser.
POST	/languages	Skapar en Language-resurs.
GET	/languages/{id}	Hämtar en Language-resurs.

Schema-fält

Språk: Schema-fält
Fält	Typ	Beskrivning
id*	string

Integration

Endpoints

Integration: Endpoints
Metod	Sökväg	Beskrivning
POST	/integrations/kontomatik/pull	Skapar en Integration-resurs.
POST	/integrations/kontomatik/revoke	Skapar en Integration-resurs.
POST	/integrations/kontomatik/setup	Skapar en Integration-resurs.

Möte

Endpoints

Möte: Endpoints
Metod	Sökväg	Beskrivning
GET	/meetings	Hämtar samlingen av Meeting-resurser.
POST	/meetings	Skapar en Meeting-resurs.
GET	/meetings/{id}	Hämtar en Meeting-resurs.
PATCH	/meetings/{id}	Uppdaterar Meeting-resursen.

Schema-fält

Möte: Schema-fält
Fält	Typ	Beskrivning
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Prenumeration

Endpoints

Prenumeration: Endpoints
Metod	Sökväg	Beskrivning
GET	/subscriptions	Hämtar samlingen av Subscription-resurser.
POST	/subscriptions	Skapar en Subscription-resurs.
GET	/subscriptions/{id}	Hämtar en Subscription-resurs.
POST	/subscriptions/{id}/cancel	Skapar en Subscription-resurs.
GET	/subscriptions/{id}/invoices	Hämtar samlingen av Subscription-resurser.
POST	/subscriptions/apply-coupon	Skapar en Subscription-resurs.
POST	/subscriptions/clear-coupon	Skapar en Subscription-resurs.

Schema-fält

Prenumeration: Schema-fält
Fält	Typ	Beskrivning
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

Organisationsadress

Endpoints

Organisationsadress: Endpoints
Metod	Sökväg	Beskrivning
GET	/organization-addresses	Hämtar samlingen av OrganizationAddress-resurser.
POST	/organization-addresses	Skapar en OrganizationAddress-resurs.
GET	/organization-addresses/{id}	Hämtar en OrganizationAddress-resurs.
PATCH	/organization-addresses/{id}	Uppdaterar OrganizationAddress-resursen.
DELETE	/organization-addresses/{id}	Tar bort OrganizationAddress-resursen.

Schema-fält

Organisationsadress: Schema-fält
Fält	Typ	Beskrivning
type*	string
name*	string
street*	string
city*	string
postCode*	string
country*	string
email	string,null (email)
tin	stringnull
tinCountry	stringnull

Organisationskonfiguration

Endpoints

Organisationskonfiguration: Endpoints
Metod	Sökväg	Beskrivning
GET	/configs	Get multiple configuration values
GET	/configs/{id}	Hämtar en OrganizationConfig-resurs.
PATCH	/configs/{id}	Uppdaterar OrganizationConfig-resursen.

Schema-fält

Organisationskonfiguration: Schema-fält
Fält	Typ	Beskrivning
type*	string
name*	string

Organisationsanvändare

Endpoints

Organisationsanvändare: Endpoints
Metod	Sökväg	Beskrivning
GET	/organization-users	Hämtar samlingen av OrganizationUser-resurser.
DELETE	/organization-users/{id}	Tar bort OrganizationUser-resursen.

Schema-fält

Organisationsanvändare: Schema-fält
Fält	Typ	Beskrivning
id	string
organization	string (iri-reference)
user	string (iri-reference)
type	string
organizationUserConfigs	array
createdAt	string (date-time)
updatedAt	string (date-time)

Konfiguration för organisationsanvändare

Endpoints

Konfiguration för organisationsanvändare: Endpoints
Metod	Sökväg	Beskrivning
GET	/user-configs/{id}	Hämtar en OrganizationUserConfig-resurs.
PATCH	/user-configs/{id}	Uppdaterar OrganizationUserConfig-resursen.

Schema-fält

Konfiguration för organisationsanvändare: Schema-fält
Fält	Typ	Beskrivning
type	string
name	string
value	string

Inbjudan för organisationsanvändare

Endpoints

Inbjudan för organisationsanvändare: Endpoints
Metod	Sökväg	Beskrivning
GET	/organization-user-invitations	Hämtar samlingen av OrganizationUserInvitation-resurser.
POST	/organization-user-invitations/{id}/accept	Skapar en OrganizationUserInvitation-resurs.
POST	/organization-user-invitations/{id}/reject	Skapar en OrganizationUserInvitation-resurs.
POST	/organization-user-invitations/{id}/retry	Skapar en OrganizationUserInvitation-resurs.

Schema-fält

Inbjudan för organisationsanvändare: Schema-fält
Fält	Typ	Beskrivning
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.

Post i konfigurationsnyckelkatalog

Endpoints

Post i konfigurationsnyckelkatalog: Endpoints
Metod	Sökväg	Beskrivning
GET	/config-keys	Hämtar samlingen av ConfigKeyCatalogItem-resurser.

Schema-fält

Post i konfigurationsnyckelkatalog: Schema-fält
Fält	Typ	Beskrivning
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.