Get Tenants

GET /v1/tenant/

Retrieves a collection of tenants for the authenticated context. Each tenant includes identifiers, hierarchy relationships (parent, parents, childs), and metadata such as MSP status, integrations, and SSO configuration. This allows clients to display tenant trees and account hierarchies accurately.

Response Example

[
  {
    "_id": "tenant-db-id-1",
    "name": "Example Root Tenant",
    "childs": [
      "tenant-id-2",
      "tenant-id-3",
      "tenant-id-4",
      "tenant-id-5",
      "tenant-id-6",
      "tenant-id-7"
    ],
    "msp": false,
    "sso": [],
    "parents": ["root-parent-id-1"],
    "id": "tenant-id-1",
    "integrations": [],
    "parent": "root-parent-id-1",
    "__v": 32
  },
  {
    "_id": "tenant-db-id-2",
    "name": "Example Customer A",
    "childs": [],
    "msp": false,
    "sso": [],
    "parents": ["tenant-id-1", "root-parent-id-1"],
    "id": "tenant-id-2",
    "integrations": [],
    "parent": "tenant-id-1",
    "__v": 0
  },
  {
    "_id": "tenant-db-id-3",
    "name": "Example Customer B",
    "childs": [],
    "msp": false,
    "sso": [],
    "parents": ["tenant-id-1", "root-parent-id-1"],
    "id": "tenant-id-3",
    "integrations": [],
    "parent": "tenant-id-1",
    "__v": 0
  }
]