# List embed

URL: https://docs.hanzo.ai/docs/openapi/account/get-account-embed

> Reports whether one of this brand's shared embedded apps (cms, erp, help) may be framed by the caller and is actually running, so a console module can choose between the embed and the provision panel.

`GET /v1/account/embed`

> [Account →](https://docs.hanzo.ai/docs/openapi/account) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                         |
| ------------- | --------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/account/embed` |
| **Method**    | `GET`                                   |
| **Operation** | `get_account_embed`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`  |

Reports whether one of this brand's shared embedded apps (cms, erp,
help) may be framed by the caller and is actually running, so a console module
can choose between the embed and the provision panel.

It answers two questions the browser cannot answer for itself. ENTITLEMENT is
server-authoritative: each app is a single shared per-BRAND instance, so only a
member of the owning brand org — or a SuperAdmin — is given the embed URL; every
other caller gets phase "not-entitled" and no URL. REACHABILITY is a probe of
that origin, which a cross-origin page cannot read for itself.

The probed host is always \<app>.\<this deployment's own brand domain>: no part of
it comes from the request, so this can never be steered into probing an
arbitrary origin.

## Request

1 field.

| Field | In    | Type   | Required | Description                                                              |
| ----- | ----- | ------ | -------- | ------------------------------------------------------------------------ |
| `app` | query | string | —        | App is the embedded app to report on: cms (Content Studio), erp or help. |

## Response

| Status    | Body                    | Meaning |
| --------- | ----------------------- | ------- |
| `200`     | account.embedStatusResp | ok      |
| `default` | problem-details         | refused |

`200` body — 6 fields.

| Field       | In   | Type    | Always | Description                                                               |
| ----------- | ---- | ------- | ------ | ------------------------------------------------------------------------- |
| `app`       | body | string  | —      | App is the app this verdict is about.                                     |
| `embedUrl`  | body | string  | —      | EmbedURL is the in-app landing URL to frame.                              |
| `entitled`  | body | boolean | —      | Entitled is whether the caller's org may frame this brand-owned app.      |
| `origin`    | body | string  | —      | Origin is the app's origin on this deployment's own brand domain.         |
| `phase`     | body | string  | —      | Phase is the verdict in one word: not-entitled, not-provisioned or ready. |
| `reachable` | body | boolean | —      | Reachable is whether the app answered the liveness probe.                 |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo account embed
```

**SDK**

**.ts**

```ts
import { Configuration, AccountApi } from 'hanzoai';

const api = new AccountApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAccountEmbed();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AccountApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AccountApi(client).get_account_embed()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.AccountAPI.GetAccountEmbed(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, account_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = account_api::get_account_embed(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AccountApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new AccountApi(client).getAccountEmbed();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/account/embed \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `account`, op `get_account_embed` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "account",
         "arguments": {
           "op": "get_account_embed",
           "input": {}
         }
       }
     }'
```

---

[Account API](https://docs.hanzo.ai/docs/openapi/account) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)