Skip to main content

Tenant API

Overview​

Two lightweight, self-service endpoints scoped to the Marketing Tenant your API key belongs to — useful for monitoring integrations and for confirming which tenant an API key resolves to.

Authentication​

All endpoints require API key authentication:

X-API-Key: your-api-key-here

Get tenant info​

GET /api/tenant/info

Basic tenant identity for the authenticated API key.

Example response​

{
  "tenant_id": "9f2e1c3a-1234-4a5b-8c9d-0e1f2a3b4c5d",
  "code": "acme-co",
  "name": "Acme Co"
}

Get tenant health check​

GET /api/tenant/healthcheck

Liveness/health status for monitoring integrations, plus tenant identity, environment, and a subset of service configuration.

Example response​

{
  "tenant": {
    "tenant_id": "9f2e1c3a-1234-4a5b-8c9d-0e1f2a3b4c5d",
    "code": "acme-co",
    "name": "Acme Co",
    "sandbox_mode": false,
    "brand_settings": {
      "logo_url": "https://cdn.example.com/acme-logo.png",
      "primary_color": "#2563eb"
    }
  },
  "environment": "Production",
  "config": {
    "emailMarketing": { "jobBatchSize": 500, "transmissionBatchSize": 100 },
    "sparkPost": { "baseUrl": "https://api.sparkpost.com", "sendingDomain": "mail.acme.example.com" },
    "stack9Forms": { "baseUrl": "https://forms.stack9.io" }
  }
}

environment is one of Local, Development, UAT, PreProduction, Production.

  • Business Units API — how a Marketing Tenant is further divided into Business Units for multi-brand or multi-dealership setups.
  • Email Settings API — configure the sending domains and SparkPost settings surfaced in the config block above.