← Referência da API

Organização & configuração

Organização, localizações, integrações e assinatura — configure o workspace.

Organização

Endpoints

GET	/organizations	Retrieves the collection of Organization resources.
POST	/organizations	Creates a Organization resource.
GET	/organizations/{id}	Retrieves a Organization resource.
POST	/organizations/clear	Creates a Organization resource.
POST	/organizations/icon	Creates a Organization resource.
POST	/organizations/logo	Creates a Organization resource.
GET	/organizations/mail-footer	Retrieves a Organization resource.
PATCH	/organizations/mail-footer	Updates the Organization resource.

Campos de schema

Campo	Tipo	Descrição
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)

Localização

Endpoints

GET	/locations	Retrieves the collection of Location resources.
POST	/locations	Creates a Location resource.
GET	/locations/{id}	Retrieves a Location resource.
PATCH	/locations/{id}	Updates the Location resource.

Campos de schema

Campo	Tipo	Descrição
name*	string
officeOpenHour	integernull
officeCloseHour	integernull

País

Endpoints

GET	/countries	Retrieves the collection of Country resources.
GET	/countries/{id}	Retrieves a Country resource.

Campos de schema

Campo	Tipo	Descrição
id*	string

Idioma

Endpoints

GET	/languages	Retrieves the collection of Language resources.
POST	/languages	Creates a Language resource.
GET	/languages/{id}	Retrieves a Language resource.

Campos de schema

Campo	Tipo	Descrição
id*	string

Integração

Endpoints

POST	/integrations/kontomatik/pull	Creates a Integration resource.
POST	/integrations/kontomatik/revoke	Creates a Integration resource.
POST	/integrations/kontomatik/setup	Creates a Integration resource.

Reunião

Endpoints

GET	/meetings	Retrieves the collection of Meeting resources.
POST	/meetings	Creates a Meeting resource.
GET	/meetings/{id}	Retrieves a Meeting resource.
PATCH	/meetings/{id}	Updates the Meeting resource.

Campos de schema

Campo	Tipo	Descrição
employee*	string,null (iri-reference)
dateFrom*	string (date-time)
dateTo*	string (date-time)
notes	stringnull
time	string,null (date-time)

Assinatura

Endpoints

GET	/subscriptions	Retrieves the collection of Subscription resources.
POST	/subscriptions	Creates a Subscription resource.
GET	/subscriptions/{id}	Retrieves a Subscription resource.
POST	/subscriptions/{id}/cancel	Creates a Subscription resource.
GET	/subscriptions/{id}/invoices	Retrieves the collection of Subscription resources.
POST	/subscriptions/apply-coupon	Creates a Subscription resource.
POST	/subscriptions/clear-coupon	Creates a Subscription resource.

Campos de schema

Campo	Tipo	Descrição
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