Get Tenant

GET

/tenant/{tenantId}

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

tenantId

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

connectUrl

WebSocket connection URL for IoT/OCPP

string

customDomains

WebSocket URLs of every fully configured (COMPLETE) custom domain

Array<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

nullable

Example

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

401

Missing, invalid or expired credentials

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}