Skip to main content
SONZAI
Api

Tenants

List tenants

GET
/tenants

Authorization

bearerClerk
AuthorizationBearer <token>

Clerk session JWT from an authenticated dashboard user. Format: Bearer eyJ....

In: header

Response Body

application/json

application/problem+json

curl -X GET "https://loading/api/v1/tenants"
[
  {
    "$schema": "/api/v1/schemas/Tenant.json",
    "clerk_org_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "is_active": true,
    "license_key_id": "string",
    "name": "string",
    "slug": "string",
    "tenant_id": "string"
  }
]
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Get a tenant

GET
/tenants/{tenantId}

Authorization

bearerClerk
AuthorizationBearer <token>

Clerk session JWT from an authenticated dashboard user. Format: Bearer eyJ....

In: header

Path Parameters

tenantId*string

Tenant UUID

Response Body

application/json

application/problem+json

curl -X GET "https://loading/api/v1/tenants/string"
{
  "$schema": "/api/v1/schemas/Tenant.json",
  "clerk_org_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "license_key_id": "string",
  "name": "string",
  "slug": "string",
  "tenant_id": "string"
}
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}