DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List tenants GETGet a tenant GETUpdate a tenant PUTCreate a sub-tenant POST
Tenants

Get a tenant

List tenants GET

Every tenant the caller can act on: the key's own tenant and all its sub-tenants, sorted by name.

Update a tenant PUT

Replaces the tenant's name, domain and external id. The tenant type cannot be changed.

GET
/v1/tenants/{tenantId}

Required permission: tenants:read

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

Response Body

The tenant.

  1. response
  1. response
  2. …

A tenant (organisation) in the tenant hierarchy.

id*string

Tenant id.

name*string

Display name.

parentId?string

Parent tenant id.

type*string

Tenant type. Determines which child types it may contain: main → main, sub, customer; sub → customer; customer has no children.

Value in"main""sub""customer"
domain?string

Email domain of the organisation (e.g. example.com), unique across tenants. Optional.

extraId?string

Your own reference for this tenant (e.g. a CRM or billing id). Optional, free text.

region*string

Data region the tenant's data lives in (eu); chosen when the tenant was created, and carried by its API keys (evk_eu_...).

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string'
Example Response
{  "id": "string",  "name": "string",  "parentId": "string",  "type": "main",  "domain": "string",  "extraId": "string",  "region": "string"}
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string'
{
  "id": "string",
  "name": "string",
  "parentId": "string",
  "type": "main",
  "domain": "string",
  "extraId": "string",
  "region": "string"
}