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 pending invitations

Remove a member DELETE

Removes the user's membership of this tenant. The user account itself is not deleted.

Invite a user POST

- If an account with this email exists, the user is added to the tenant directly and notified by email (204). - Otherwise an invitation email is sent with a link that is valid for 7 days (202). Inviting the same email again updates the role and resends the invitation.

GET
/v1/tenants/{tenantId}/invites

Invitations that have not been accepted yet, sorted by email. Expired ones are included; check expiresUtc.

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 pending invitations.

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

A pending invitation.

Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/invites'
Example Response
[  {    "id": "string",    "email": "string",    "role": "User",    "expiresUtc": "2019-08-24T14:15:22Z",    "accepted": true  }]
Example Request
curl -X GET 'https://api.envocal.ai/v1/tenants/string/invites'
[
  {
    "id": "string",
    "email": "string",
    "role": "User",
    "expiresUtc": "2019-08-24T14:15:22Z",
    "accepted": true
  }
]