---
title: "List sponsorable domains"
method: GET
path: "/v1/domains/{domainId}/account/{entityId}/sponsorable-domains"
tags: ["Gas station"]
---

# List sponsorable domains

`GET /v1/domains/{domainId}/account/{entityId}/sponsorable-domains`

## 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}/account/{entityId}/sponsorable-domains`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/account/:entityId/sponsorable-domains/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `domainId` string, required
- `entityId` string, required

## Query parameters

- `status` 'sponsored' | 'not_sponsored' | 'sponsored_by_other'
- `search` string
- `limit` number
- `page` number

## Response `200`

- GasStationSponsorableDomainsResponseDto
  - `items` GasStationSponsorableDomainDto[], required
    - `domainId` string, required: Domain UUID
    - `name` string, required: Domain name
    - `ledgers` GasStationLedgerDto[], required
      - `id` string, required
      - `alias` string, required
    - `sponsorshipStatus` 'sponsored' | 'not_sponsored' | 'sponsored_by_other', required
    - `sponsorshipDetails` GasStationSponsorshipDetailsDto
      - `sponsorAccountId` string, required: The sponsoring gas station account ID
      - `sponsorAccountName` string, required: The sponsoring gas station account name
      - `sponsorType` 'account' | 'domain', required: How this was sponsored
      - `sponsoredDomainId` string: If sponsored via domain, the domain ID
      - `sponsoredDomainName` string: If sponsored via domain, the domain name
    - `accountIds` string[], required: Account IDs within this domain
    - `parentId` object: Parent domain UUID, null only for absolute root (typically filtered out)
    - `depth` number, required: Nesting depth relative to sponsor domain (0 = direct child of sponsor domain)
    - `hasAccountsSponsoredByOther` boolean, required: Whether any accounts in this domain are individually sponsored by another gas station
    - `children` GasStationSponsorableDomainDto[], required: Nested subdomains (hierarchical)
  - `total` number, required
  - `page` number, required: Current page number (0-indexed)
  - `pageSize` number, required: Page size
  - `availableLedgers` GasStationLedgerDto[], required: All available ledgers for filter dropdown
    - `id` string, required
    - `alias` string, required

---

[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)