Skip to main content
GET
/
api
/
v1
/
hub
/
shop
/
{shopId}
/
domains
/
check-scale
/
{subdomain}
Check Subdomain Availability
curl --request GET \
  --url https://api.getscale.ng/api/v1/hub/shop/{shopId}/domains/check-scale/{subdomain} \
  --header 'X-Shop-API-Key: <x-shop-api-key>'
{
  "status": "success",
  "data": {
    "available": true
  }
}
Verifies whether a desired Scale subdomain is currently free for registration.

​
Authorizations

​
X-Shop-API-Key
string
required
Your Secret API Key (sk_live_... or sk_test_...) generated from the Developer dashboard. Must be kept secret.

​
Path Parameters

​
shopId
string
required
The unique UUID of the shop.
​
subdomain
string
required
The subdomain name prefix to check (e.g. myshop).
{
  "status": "success",
  "data": {
    "available": true
  }
}