Domains

Get the organization's addresses

branding.domains.get

Returns the addresses the organization has registered, on two surfaces: team_access (the white-label app the agency's team uses) and client_portal (what its clients open), each with custom_domain (its own hostname, with verified: the hosting provider confirmed the DNS) and subdomain (<label>.mb-suite.com), or null where there is none. Each address has host, kind, enabled (an address can be kept but turned off) and added_at. cname_target is where a custom domain's CNAME must point (cname.vercel-dns.com). It calls no external provider. Requires view access to Branding.

Scope

branding:read

Permission

View the module

MCP tool

branding_domains_getOn the full surface; on the compact one, mb_execute_operation with id: "branding.domains.get".

Declared cost: up to 1 reads and 0 writes per call (they count against the daily quota).

Parameters

No parameters.

Response

Errors

Example

curl "https://api.mb-suite.com/v1/branding/domains" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/branding/domains" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Check whether an address is available

branding.domains.check_availability

Says whether this organization could register an address on a surface (team_access by default, or client_portal) without changing anything or calling the hosting provider. host is a full hostname (app.youragency.com, or youragency.mb-suite.com for an MB Suite subdomain) or just a subdomain label (youragency). Returns host (always the full hostname: youragency.mb-suite.com for a subdomain), label (the subdomain label; null for a custom domain), kind (custom_domain or subdomain), available, current (the organization already has it on that surface) and, when not available, reason and message (in the language of the messages): format, length (a label is 3 to 63 letters, digits or hyphens), reserved (labels MB Suite keeps: api, mcp, app, www…), platform (mb-suite.com itself or a hosting provider's domain cannot be a custom domain), taken_other_organization or taken_other_surface (this organization already uses it on the other surface). Requires view access to Branding.

Scope

branding:read

Permission

View the module

MCP tool

branding_domains_check_availabilityOn the full surface; on the compact one, mb_execute_operation with id: "branding.domains.check_availability".

Declared cost: up to 15 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/branding/domains/availability?host=HOST" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/branding/domains/availability?host=HOST" \
  -H "Authorization: Bearer $MB_TEST_KEY"