Skip to content

Tenants API

Maintained by: Aether365 Team Audience: Developers Scope: Tenant API endpoints - reading and updating tenant configuration

Get Current Tenant

Returns the authenticated tenant's profile and plan information.

GET /tenants/me

Example Request

bash
curl https://api.aether365.io/tenants/me \
  -H "Authorization: Bearer <token>"

Example Response

json
{
  "success": true,
  "data": {
    "id": "t_abc123",
    "email": "admin@example.com",
    "companyName": "Example Corp",
    "planTier": "pro",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-04-01T08:30:00Z"
  }
}

Response Fields

FieldTypeDescription
idstringTenant identifier
emailstringAccount owner email
companyNamestringCompany name (derived from email domain)
planTierstringCurrent plan: free, pro, enterprise
createdAtstringISO 8601 timestamp of account creation
updatedAtstringISO 8601 timestamp of last update

Update Tenant Profile

Updates the tenant's display name.

PATCH /tenants/me

Request Body

json
{
  "companyName": "Acme Security Ltd"
}
FieldTypeRequiredDescription
companyNamestringNoDisplay name for the tenant

Example Request

bash
curl -X PATCH https://api.aether365.io/tenants/me \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"companyName": "Acme Security Ltd"}'

Example Response

json
{
  "success": true,
  "data": {
    "id": "t_abc123",
    "email": "admin@example.com",
    "companyName": "Acme Security Ltd",
    "planTier": "pro",
    "createdAt": "2026-01-15T10:00:00Z",
    "updatedAt": "2026-04-10T12:00:00Z"
  }
}
Was this page helpful?