---
title: "Get the omnibus structure for a domain"
method: GET
path: "/v1/domains/{domainId}/omnibus"
tags: ["Omnibus"]
---

# Get the omnibus structure for a domain

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

## Request

- Base URL: `https://docs.ripple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.ripple.com/v1/domains/{domainId}/omnibus`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/omnibus/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `domainId` string, uuid, required

## Response `200`

OK

- OmnibusOmnibusResponse
  - `id` string, uuid, required: Unique identifier of the omnibus structure
  - `domainId` string, uuid, required: Identifier of the domain this omnibus structure belongs to
  - `custodyAccountId` string, uuid, required: Identifier of the custody account backing this omnibus structure
  - `alias` string, required: Alias of the omnibus structure
  - `status` 'CREATING' | 'PENDING_SPONSORSHIP' | 'ACTIVE' | 'FAILED', required
  - `lockStatus` 'UNLOCKED' | 'LOCKED', required
  - `ignoredAccountIds` string[], required: List of custody account IDs to ignore during event processing
  - `createdAt` string, date-time, required: Timestamp when the omnibus structure was created
  - `updatedAt` string, date-time, required: Timestamp when the omnibus structure was last updated
  - `sponsoringGasStationId` string, uuid: Entity ID of the Gas Station account that sponsors fees for this omnibus account
  - `balances` OmnibusTenantBalanceEntry[]: Balances of the host tenant 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

## Other responses

- `404`: Omnibus structure not found for this domain

---

[API](https://skmtc.dev/ripple/apis/ripple-custody-api.md) - [All operations](https://skmtc.dev/ripple/apis/ripple-custody-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ripple/apis/ripple-custody-api/revisions/c6f0ad6b70c0?raw)