Get a tenant — never returns api_secret

GET

/admin/tenants/{id}

const url = 'http://localhost:3000/admin/tenants/example';
const options = {method: 'GET', headers: {'X-Admin-Key': '<X-Admin-Key>'}};

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

curl --request GET \
  --url http://localhost:3000/admin/tenants/example \
  --header 'X-Admin-Key: <X-Admin-Key>'

Authorizations

adminKey

Parameters

Path Parameters

required

string

Responses

200

The tenant.

application/json

object

string

name

string

api_key

string

status

string

Allowed values: active suspended

created_at

string format: date-time

Example

{
  "status": "active"
}