Read one visible tenant.

GET

/v1/tenants/{tenantNumber}

const url = 'https://api.dev.iot-sens.schlossers.at/v1/tenants/1';
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.dev.iot-sens.schlossers.at/v1/tenants/1 \
  --header 'Authorization: Bearer <token>'

Authorizations

AccessToken

Parameters

Path Parameters

tenantNumber

required

integer format: int32

>= 1 <= 2147483647

Responses

200

Tenant details.

application/json

object

tenantId

required

string format: uuid

tenantNumber

required

integer format: int32

>= 1 <= 2147483647

key

required

string

/^[a-z0-9][a-z0-9_-]{0,63}$/

name

required

string

>= 1 characters <= 200 characters

status

required

string

Allowed values: active disabled

metadata

required

object

<= 50 properties

key

additional properties

One of:

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "status": "active"
}

default

A safe platform error response.

application/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED AUTHENTICATION_FAILED AUTHORIZATION_FAILED RESOURCE_NOT_FOUND CONFLICT DEPENDENCY_FAILURE FLOW_FAILURE RATE_LIMITED INTERNAL_ERROR

category

required

string

Allowed values: validation authentication authorization not_found conflict dependency_failure flow_failure rate_limit internal

message

required

Safe client-facing diagnostic message.

string

correlationId

required

Correlation ID for operational investigation.

string

>= 1 characters

details

Safe bounded diagnostic details.

object

key

additional properties

One of:

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED",
    "category": "validation"
  }
}

Headers

Cache-Control

string

Allowed value: no-store