Get Tenant

GET

/tenant/{tenant}

const url = 'https://api.exolink.cloud/tenant/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.exolink.cloud/tenant/example \
  --header 'Authorization: Bearer <token>'

Retrieve tenant information

Authorizations

bearerToken

Parameters

Path Parameters

tenant

required

string

Tenant domain prefix

Responses

200

Tenant information

application/json

object

Unique identifier for the tenant

integer

name

Tenant display name

string

domainPrefix

Unique domain prefix for the tenant (used in URLs and subdomains)

string

stripeCustomerId

Stripe customer ID for billing

string

connectUrl

WebSocket connection URL for IoT/OCPP

string

customDomain

Custom domain WebSocket URL (if configured)

string

createdAt

When the tenant was created

string format: date-time

updatedAt

When the tenant was last updated

string format: date-time

deletedAt

When the tenant was deleted (null if active)

string format: date-time

Example

{
  "id": 1,
  "name": "My Company",
  "domainPrefix": "abc123",
  "connectUrl": "wss://abc123.broker.exolink.cloud/",
  "customDomain": "wss://chargers.company.com/"
}