---
title: "List tenants"
method: GET
path: "/eclipse-conductor/rest/v1/tenants"
tags: ["b) Tenant Configuration & Onboarding"]
---

# List tenants

`GET /eclipse-conductor/rest/v1/tenants`

Returns all tenants registered on the platform. Only available to administrators. Results can be filtered by name or institution.

## Query parameters

- `fields` string
- `institution` string
- `limit` integer
- `name` string
- `offset` integer
- `onlyShowAllowed` boolean

## Response `200`

OK

- EclipseTenant[]
  - `base64ExportedTenantConfiguration` string — Optional. It is tenant detail like wallet type, wallet, admin users exported Tenant Configuration as JSON
  - `businessType` 'CLOSE_CORPORATION' | 'LIMITED_COMPANY' | 'PARTNERSHIP' | 'PERSONAL_LIABILITY_COMPANY' | 'PUBLIC_LISTED_COMPANY' | 'SOLE_PROPRIETOR' | 'STATE_OWNED_COMPANY' | 'TRUST' | 'UNREGISTERED'
  - `categoryCode` integer — Four digit Category code for this tenant.
  - `companyNumber` string — Legal company number of the tenant
  - `created` string, date-time — ISO 8601 date/time of when the record was first created
  - `email` string — Primary email address of the tenant
  - `industrialClassification` string
  - `industrialSector` string
  - `institution` string — Optional. The accountable institution that the tenant falls under
  - `lastModified` string, date-time — ISO 8601 date/time of when the record was last modified
  - `merchantId` string — Merchant Id used for some card payment types to the tenants wallet
  - `name` string — Name of the tenant - typically company name
  - `phone1` string, required — Tenants primary phone number
  - `poolAccountNumbers` PoolAccountData[] — Pool accounts linked to wallet types on the tenant
    - `accountNumber` string
    - `currency` string
    - `walletTypeId` integer
  - `primaryPoolAccountNumber` string
  - `status` 'ACTIVE' | 'BARRED' | 'INACTIVE' — Status of the eclipse organisation. ACTIVE:Organisation is active, INACTIVE:Organisation is in active, BARRED:Organisation is in barred
  - `taxNumber` string — Tax number of the tenant
  - `tenantId` integer — Unique identifier for a tenant. System generated upon creation of a new tenant. Should be passed as a path parameter for many of the API's which are specific to the tenant
  - `tradingName` string
  - `vatNumber` string — VAT number of Tenant
  - `version` integer, required — A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.
  - `walletIdentifiers` string[]

---

[API](https://skmtc.dev/eftcorp/apis/eclipse-rest-api.md) · [All operations](https://skmtc.dev/eftcorp/apis/eclipse-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/eftcorp/eclipse-rest-api/revisions/9213d52d49a3/schema)