Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ivory.finance/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

GET /v1/admin/tenants/{slug} returns the complete tenant record including credentials and Stripe IDs.
This endpoint is restricted to the admin Kong consumer via ACL. The tenant service key is intentionally masked and never returned.

​
Path parameters

​
slug
string
required
The tenant slug (e.g. acme-bank).

​
Response

​
tenant_id
string
UUID of the tenant.
​
slug
string
URL-safe tenant identifier.
​
display_name
string
Human-readable tenant name.
​
region
string
Data residency region.
​
tier
string
pilot · enterprise · enterprise_plus
​
supabase_url
string
Tenant database URL. Null until step 1 completes.
​
supabase_project_ref
string
Tenant environment reference ID. Null until step 1 completes.
​
falkordb_graph_name
string
Name of the tenant’s private FalkorDB graph. Null until step 6 completes.
​
custom_domain
string
Custom domain if configured, otherwise null.
​
admin_email
string
Email of the tenant admin.
​
provisioning_state
string
provisioning · active · failed · deprovisioned
​
is_active
boolean
Whether the tenant is live and routing.
​
provisioned_at
string
ISO 8601 timestamp of row creation.
​
error_message
string
Last provisioning error, if state is failed. Null otherwise.
​
stripe_customer_id
string
Stripe customer ID, if billing was set up at step 9.

​
Examples

curl https://api.ivory.finance/v1/admin/tenants/acme-bank \
  -H "X-API-Key: YOUR_ADMIN_KEY"
Response: 
{
  "tenant_id":            "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
  "slug":                 "acme-bank",
  "display_name":         "Acme Bank",
  "region":               "us-east-1",
  "tier":                 "enterprise",
  "supabase_url":         "https://acme-bank.ivory.finance",
  "supabase_project_ref": "xyzrefabc123",
  "falkordb_graph_name":  "client_acme-bank",
  "custom_domain":        null,
  "admin_email":          "admin@acmebank.com",
  "provisioning_state":   "active",
  "is_active":            true,
  "provisioned_at":       "2026-03-24T10:00:00+00:00",
  "error_message":        null,
  "stripe_customer_id":   "cus_abc123xyz"
}

​
Error responses

CodeReason
404No tenant found with that slug