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 returns a summary list of every tenant row in control.tenants, regardless of state.
This endpoint is restricted to the admin Kong consumer via ACL.

​
Response

Returns an array of tenant summary objects.
​
tenant_id
string
UUID of the tenant.
​
slug
string
URL-safe tenant identifier.
​
display_name
string
Human-readable tenant name.
​
tier
string
pilot · enterprise · enterprise_plus
​
region
string
Data residency region.
​
provisioning_state
string
Current state: provisioning · active · failed · deprovisioned
​
is_active
boolean
true only once provisioning completes successfully. TenantMiddleware only routes requests for active tenants.
​
provisioned_at
string
ISO 8601 timestamp of tenant row creation.

​
Examples

curl https://api.ivory.finance/v1/admin/tenants \
  -H "X-API-Key: YOUR_ADMIN_KEY"
Response: 
[
  {
    "tenant_id":          "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
    "slug":               "acme-bank",
    "display_name":       "Acme Bank",
    "tier":               "enterprise",
    "region":             "us-east-1",
    "provisioning_state": "active",
    "is_active":          true,
    "provisioned_at":     "2026-03-24T10:00:00+00:00"
  },
  {
    "tenant_id":          "b2c3d4e5-6f70-8901-bcde-f12345678901",
    "slug":               "delta-capital",
    "display_name":       "Delta Capital",
    "tier":               "pilot",
    "region":             "eu-central-1",
    "provisioning_state": "provisioning",
    "is_active":          false,
    "provisioned_at":     "2026-03-24T11:30:00+00:00"
  }
]