AppNameAppName/ApiDocsBadgeApiDocsBackToSite

Poll Onboarding Status

GET/external/v1/tenants/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. The tenant is identified by the domain_url query parameter.

ApiDocsParametersTitle

ApiDocsParamFieldApiDocsParamTypeApiDocsParamRequiredApiDocsParamDescription
domain_urlstringApiDocsRequiredQuery parameter — the subdomain prefix returned by Create Tenant (e.g. acme-corp).
ApiDocsRequestLabel
curl "https://backend.app.lynxledger.com/external/v1/tenants/status/?domain_url=acme-corp" \
  -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": []
  }
}