List Tenant IDs

​

When to use it

• Org-level admin dashboards – show all tenants belonging to an organization
• Audit and compliance – generate a complete tenant inventory
• Recovery – identify tenants whose creation failed and may need to be re-created

​

Endpoint

• Auth: Bearer token
• Idempotency: Read-only
• Async: No

​

Example

curl 'https://api.hydradb.com/tenants/tenant_ids' \
  -H "Authorization: Bearer <your_api_key>"

const response = await client.tenant.getTenantIds();
const tenantIds = response.tenant_ids;

response = client.tenant.get_tenant_ids()
tenant_ids = response.tenant_ids

​

Query parameters

​

Response

{
  "tenant_ids": ["my_first_tenant", "acme_corp", "test_env"],
  "failed_tenant_ids": [
    {
      "tenant_id": "broken_tenant",
      "error": "Provisioning failed: vectorstore unreachable"
    }
  ],
  "message": "Successfully retrieved tenant IDs"
}

​

Related endpoints

• Related: Create tenant – re-create a tenant whose creation failed
• Related: Check infra status – inspect provisioning status for an individual tenant

​

Errors