---
title: "List all tenants within an omnibus structure"
method: GET
path: "/v1/domains/{domainId}/omnibus/{omnibusId}/tenants"
tags: ["Tenants"]
---

# List all tenants within an omnibus structure

`GET /v1/domains/{domainId}/omnibus/{omnibusId}/tenants`

## Path parameters

- `domainId` string, uuid, required
- `omnibusId` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `search` string
- `status` 'LOCKED' | 'UNLOCKED'

## Response `200`

OK

- OmnibusTenantPageResponse
  - `content` OmnibusTenantResponse[], required
    - `id` string, uuid, required — Unique identifier of the tenant
    - `omnibusId` string, uuid, required — Identifier of the omnibus structure this tenant belongs to
    - `alias` string, required — Alias of the tenant
    - `isHost` boolean, required — Whether this tenant is the host tenant of the omnibus structure. This field is immutable and set at creation time.
    - `status` 'LOCKED' | 'UNLOCKED', required
    - `createdAt` string, date-time, required — Timestamp when the tenant was created
    - `updatedAt` string, date-time, required — Timestamp when the tenant was last updated
    - `balances` OmnibusTenantBalanceEntry[] — Balances per ticker/ledger combination
      - `tickerId` string, uuid, required — Ticker identifier
      - `ledgerId` string, required — Ledger identifier
      - `reserved` string, required — Reserved amount
      - `quarantined` string, required — Quarantined amount
      - `availableBalance` string — Available balance from accounting service; absent if the accounting service is unavailable
    - `description` string — Description of the tenant
    - `customProperties` OmnibusTenantCustomProperty[] — Custom key-value properties
      - `key` string, required — Property key
      - `value` string, required — Property value
  - `page` OmnibusTenantPageMetadata, required — Pagination metadata for tenant listings. Unlike the shared PageMetadata, totalElements/totalPages are optional: the alias-search path uses a cursor-style (Slice) query that does not compute totals, while the full-list path still populates them.
    - `number` integer, required — Current page number (0-indexed)
    - `size` integer, required — Number of elements per page
    - `totalElements` integer — Total number of elements across all pages. Absent for cursor-style (Slice) responses such as alias search, where totals are not computed.
    - `totalPages` integer — Total number of pages. Absent for cursor-style (Slice) responses such as alias search, where totals are not computed.
    - `first` boolean, required — Whether this is the first page
    - `last` boolean, required — Whether this is the last page

## Other responses

- `404` — Domain or omnibus structure not found

---

[API](https://skmtc.net/ripple/apis/ripple-custody-api.md) · [All operations](https://skmtc.net/ripple/apis/ripple-custody-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripple-custody-api/revisions/0b55c0ddf07a/schema)