DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List members of a tenant GETChange a member's role PATCHRemove a member DELETEList pending invitations GETInvite a user POSTResend an invitation POSTWithdraw an invitation DELETE
Members & invites

List members of a tenant

Create a sub-tenant POST

Creates a tenant under the tenant in the URL (current for the key's own tenant, or the id of one of its sub-tenants).

Change a member's role PATCH

Requires members:write

GET
/v1/tenants/{tenantId}/members

Direct members only, sorted by email. Members of parent tenants also have access but are listed at their own tenant.

Required permission: members: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 members.

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

A direct member of a tenant.

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/members'
Example Response
[  {    "tenantId": "string",    "userId": "string",    "email": "string",    "firstName": "string",    "lastName": "string",    "role": "User"  }]
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/members'
[
  {
    "tenantId": "string",
    "userId": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "role": "User"
  }
]