DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

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

List tenants

Identify the caller GET

The API key you are calling with and its tenant. Start here: tenantId is what current stands for in /v1/tenants/current/..., and GET /v1/tenants lists that tenant with all its sub-tenants. Works with any valid key, whatever its permissions.

Get a tenant GET

Requires tenants:read

GET
/v1/tenants

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

Required permission: tenants:read

Authorization

Bearer
headerAuthorizationBearer <token>

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

Query Parameters

extraId?string

Only tenants with this external id (the extraId you gave them, e.g. your own customer number).

Response Body

The reachable tenants.

  1. response
  1. response
  2. …
[index: integer]?

A tenant (organisation) in the tenant hierarchy.

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants'
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'
[
  {
    "id": "string",
    "name": "string",
    "parentId": "string",
    "type": "main",
    "domain": "string",
    "extraId": "string",
    "region": "string"
  }
]