v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB
Tenants

List all tenants

List all tenants with pagination. Filter by status if needed.

get/tenants

Query parameters

pageinteger

Page number (1-indexed)

perPageinteger

Number of items per page (max 100)

status'active' | 'suspended' | 'archived'

Filter by tenant status

Response

List of tenants

pageinteger required

Current page number (1-indexed)

perPageinteger required

Items per page

totalinteger required

Total number of tenants

totalPagesinteger required

Total number of pages

Example response

{
  "data": [
    {
      "id": "cm6abc123def456ghi789",
      "name": "Acme Corp",
      "metadata": {
        "plan": "pro",
        "internalId": "cust_12345"
      },
      "status": "active",
      "createdAt": "2026-02-03T10:30:00Z",
      "updatedAt": "2026-02-03T10:30:00Z"
    }
  ],
  "page": 1,
  "perPage": 20,
  "total": 42,
  "totalPages": 3,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}