v4

latestOpenAPI 3.1.0AGPL-3.02026-08-0821527.0 KB

Get your branded 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.

get/v1/account/subdomain

Response

The branded subdomain on your account.

subdomainstring nullable

The claimed label, or null.

hoststring nullable

The full branded host, or null.

suspendedboolean

Claimed but not currently serving (not on Pro).