Skip to main content
GET
http://localhost:3000
/
tenants
curl -X GET 'https://api.example.com/tenants?status=active' \
  -H 'Authorization: Bearer YOUR_TOKEN'

[
  {
    "id": "tenant_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "name": "Acme Corp",
    "kind": "standard",
    "scopeId": "scope_acme",
    "slug": "acme-corp",
    "planKey": "pro",
    "status": "active",
    "maxUsers": 50,
    "maxWorkspaces": 10,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
]

​
Query Parameters

​
status
string
Filter by tenant status. One of: active, suspended, pending, deleted
​
kind
string
Filter by tenant kind. One of: standard, enterprise, trial
​
planKey
string
Filter by plan key

​
Response

Returns an array of tenant objects. 
curl -X GET 'https://api.example.com/tenants?status=active' \
  -H 'Authorization: Bearer YOUR_TOKEN'

[
  {
    "id": "tenant_0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "name": "Acme Corp",
    "kind": "standard",
    "scopeId": "scope_acme",
    "slug": "acme-corp",
    "planKey": "pro",
    "status": "active",
    "maxUsers": 50,
    "maxWorkspaces": 10,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
]