---
title: "Get your branded subdomain"
method: GET
path: "/v1/account/subdomain"
---

# Get your branded subdomain

`GET /v1/account/subdomain`

Returns the branded subdomain claimed on your account, if any. `suspended` is true when the name is still reserved for you but is not currently serving because your plan isn't Pro — in that state a request to the branded host redirects to the plain short link rather than failing, so printed codes keep working.

## Response `200`

The branded subdomain on your account.

- object
  - `subdomain` string, nullable — The claimed label, or null.
  - `host` string, nullable — The full branded host, or null.
  - `suspended` boolean — Claimed but not currently serving (not on Pro).

## Other responses

- `401` — The `Authorization: Bearer oqr_…` header is missing or the API key is invalid or revoked.
- `500` — An unexpected server-side error.

## Changes

- **2026-08-08** `706b4ff45a32` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/openqr/apis/openqr-api/changes/v1/account/subdomain/get.md)

---

[API](https://skmtc.dev/openqr/apis/openqr-api.md) · [All operations](https://skmtc.dev/openqr/apis/openqr-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openqr/openqr-api/revisions/0f28d209971b/schema)