Skip to main content
GET
/
v1
/
domains
/
managed
/
check
/
{prefix}
Node.js SDK
import Migma from 'migma';

const migma = new Migma('YOUR_API_KEY');

const { data, error } = await migma.domains.checkAvailability(
  'yourcompany'
);
{
  "success": true,
  "data": {
    "available": true,
    "prefix": "<string>",
    "fullDomain": "<string>",
    "reason": "<string>"
  },
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → API Integration.

Path Parameters

prefix
string
required

Subdomain prefix to check (e.g., 'acme' for acme.migma.email)

Required string length: 3 - 63

Response

Availability result

success
boolean
required
data
object
error
string | null