---
title: "Email-domain rules"
method: GET
path: "/stats/email-domains"
tags: ["Stats"]
---

# Email-domain rules

`GET /stats/email-domains`

## Request

- Base URL: `https://api.nippy.host`
- URL: `https://api.nippy.host/stats/email-domains`
- Auth: `bearer` (a scheme the document does not define)

Admin-only. Every admin-managed rule, newest first, with the number of existing users on each domain, plus the size and source of the vendored community disposable-domain list the rules sit on top of.

## Response `200`

- APIEmailDomainRules
  - `rules` APIEmailDomainRule[], required
    - `id` string, required: Rule id (UUID).
    - `domain` string, required: The domain; the rule also covers subdomains.
    - `kind` 'block' | 'allow', required
    - `note` string, nullable, required
    - `createdByName` string, nullable, required: Display name of the admin who added the rule; null for seeded rules or a deleted admin.
    - `createdAt` string, required: When the rule was added (ISO 8601).
    - `existingUsers` number, required: Existing users with an address on the domain or a subdomain. They keep their sign-in: rules only apply to new addresses.
  - `communityListSize` number, required: Domains in the vendored community list.
  - `communityListSha` string, required: Upstream commit the community list is from.
  - `communityListFetchedOn` string, required: Date the community list was fetched.

## Other responses

- `403`: Admin access required

---

[API](https://skmtc.dev/nippy/apis/nippy-backend-api.md) · [All operations](https://skmtc.dev/nippy/apis/nippy-backend-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nippy/apis/nippy-backend-api/revisions/7ab23f040a55?raw)