---
title: "List custom domain shares"
method: GET
path: "/customdomains/{domainName}/share"
tags: ["customdomains"]
---

# List custom domain shares

`GET /customdomains/{domainName}/share`

## Request

- Base URL: `https://api.blaxel.ai/v0`
- URL: `https://api.blaxel.ai/v0/customdomains/{domainName}/share`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/oauth/authorize`
    - Client credentials
    - Token URL: `/oauth/token` scopes: `customdomains:get`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/customdomains/:domainName/share/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the list of workspaces (and/or the account) that a custom domain is currently shared with.

## Path parameters

- `domainName` string, required

## Response `200`

successful operation

- CustomDomainShareTarget[]
  - `status` string, required: Share status; always "active" for same-account custom domain shares.
  - `workspace` string, required: The workspace the domain is shared with, or "account" for an account-wide share.
  - `workspaceDisplayName` string: Display name of the target workspace (empty for an account-wide share).

## Other responses

- `404`: custom domain not found

---

[API](https://skmtc.dev/blaxel/apis/blaxel-control-plane.md) - [All operations](https://skmtc.dev/blaxel/apis/blaxel-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/blaxel/apis/blaxel-control-plane/revisions/dfa264bc72ee?raw)
