AppNameAppName/ApiDocsBadgeApiDocsBackToSite

Poll Onboarding Status

GET/external/v1/tenants/{domain_url}/status/

Poll the onboarding / data-import status for a tenant. Manual tenants are ready immediately; platform tenants return one component per import step so progress can be tracked.

ApiDocsParametersTitle

ApiDocsParamFieldApiDocsParamTypeApiDocsParamRequiredApiDocsParamDescription
domain_urlstringApiDocsRequiredPath parameter — the subdomain prefix returned by Create Tenant.
ApiDocsRequestLabel
curl https://<api-host>/external/v1/tenants/acme-corp/status/ \
  -H "X-API-Key: <encrypted_token>"
ApiDocsResponseLabel
{
  "status": "success",
  "status_code": 200,
  "data": {
    "tenant_domain_url": "acme-corp",
    "schema_name": "acme_corp",
    "platform": "manual",
    "overall_status": "completed",
    "components": []
  }
}