StatusDashboard
DashboardsSubscriptions

Get email domain allowlist

Retrieve the email domain allowlist configuration for a dashboard.

View Markdown

GET /app/dashboards/{id}/subscriptions/email-domain-allowlist

Returns the current email domain allowlist for a dashboard. Requires the Email plan capability (emailEnabled).


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/subscriptions/email-domain-allowlist \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "enabled": false,
  "domains": [],
  "limits": {
    "emailDomainAllowlist": 5
  }
}

limits.emailDomainAllowlist is the maximum number of domains this dashboard may store. Contact support to request an increase.


Response fields

FieldTypeDescription
enabledbooleanWhether the allowlist is enforced on public email subscribe. Same semantics as Toggle email domain allowlist.
domainsstring[]Allowed email domains. Same format as Update email domain allowlist.
limits.emailDomainAllowlistnumberMax domains per dashboard for your organization.

Error responses

StatusWhen
400Missing dashboard ID
403Org plan does not include email subscriptions
404Dashboard not found or not owned by your organization

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.