> ## Documentation Index
> Fetch the complete documentation index at: https://sendmux.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get domain-wide sender filters

> Returns the current sender-filter mode and rule set applied to every mailbox under this domain. Only sending and receiving domains support domain-wide filters. Per-mailbox rules take precedence at match time.

Responses carry a weak `ETag` — send it as `If-None-Match` to skip the body when the filter set has not changed (returns `304 Not Modified`). The same ETag is the value to use in `If-Match` on the corresponding PUT for optimistic concurrency.



## OpenAPI

````yaml /openapi-app.json get /domains/{public_id}/filters
openapi: 3.1.0
info:
  description: Programmatic access to your Sendmux email infrastructure.
  title: Sendmux API
  version: 1.0.0
servers:
  - description: API v1
    url: https://app.sendmux.ai/api/v1
security:
  - bearerAuth: []
paths:
  /domains/{public_id}/filters:
    get:
      tags:
        - Domain Filters
      summary: Get domain-wide sender filters
      description: >-
        Returns the current sender-filter mode and rule set applied to every
        mailbox under this domain. Only sending and receiving domains support
        domain-wide filters. Per-mailbox rules take precedence at match time.


        Responses carry a weak `ETag` — send it as `If-None-Match` to skip the
        body when the filter set has not changed (returns `304 Not Modified`).
        The same ETag is the value to use in `If-Match` on the corresponding PUT
        for optimistic concurrency.
      operationId: managementGetDomainFilters
      parameters:
        - in: path
          name: public_id
          required: true
          schema:
            description: Domain public ID
            type: string
        - in: header
          name: If-None-Match
          required: false
          schema:
            description: Weak ETag from a previous response. Returns 304 when unchanged.
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterStateResponse'
          description: Filter state
          headers:
            ETag:
              description: Weak ETag for conditional GETs and optimistic-concurrency PUTs.
              schema:
                example: W/"a1b2c3d4e5f60718"
                type: string
        '304':
          description: >-
            Not Modified — the client's cached copy (matching `If-None-Match`)
            is still current.
          headers:
            ETag:
              description: Current weak ETag.
              schema:
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Domain not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Domain is send-only and does not support inbound filters.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Filter service temporarily unavailable
      security:
        - bearerAuth: []
components:
  schemas:
    FilterStateResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessEnvelope'
        - properties:
            data:
              $ref: '#/components/schemas/FilterState'
            meta:
              $ref: '#/components/schemas/ResponseMeta'
          required:
            - data
          type: object
      unevaluatedProperties: false
    ApiError:
      additionalProperties: false
      properties:
        error:
          additionalProperties: false
          properties:
            code:
              description: Machine-readable error code
              enum:
                - invalid_parameter
                - missing_parameter
                - authentication_required
                - insufficient_permissions
                - not_found
                - conflict
                - limit_exceeded
                - idempotency_conflict
                - payload_too_large
                - validation_error
                - rate_limit_exceeded
                - service_unavailable
                - internal_error
              example: invalid_parameter
              type: string
            doc_url:
              description: Link to relevant documentation
              type: string
            errors:
              description: >-
                Accumulated per-field issues for validation errors. Only present
                on 400/422 responses.
              items:
                $ref: '#/components/schemas/ApiErrorDetail'
              type: array
            message:
              description: Human-readable error description
              type: string
            param:
              description: The parameter that caused the error
              type: string
            retryable:
              description: >-
                Whether the caller may safely retry this request. 4xx are
                typically false (except 429); 5xx are typically true.
              example: false
              type: boolean
          required:
            - code
            - message
            - retryable
          type: object
        meta:
          additionalProperties: false
          properties:
            request_id:
              example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
              type: string
          required:
            - request_id
          type: object
        ok:
          enum:
            - false
          type: boolean
      required:
        - ok
        - error
        - meta
      type: object
    SuccessEnvelope:
      properties:
        meta:
          additionalProperties: {}
          properties: {}
          type: object
        ok:
          enum:
            - true
          type: boolean
      required:
        - ok
        - meta
      type: object
    FilterState:
      additionalProperties: false
      properties:
        mode:
          description: >-
            Active filtering mode. `off` disables filtering (all senders
            accepted). `allowlist` only accepts senders matching a rule.
            `denylist` blocks senders matching a rule.
          enum:
            - 'off'
            - allowlist
            - denylist
          type: string
        rules:
          description: Current rules, sorted by pattern ascending
          items:
            $ref: '#/components/schemas/FilterRule'
          type: array
      required:
        - mode
        - rules
      type: object
    ResponseMeta:
      additionalProperties: false
      properties:
        request_id:
          example: req_clxxxxxxxxxxxxxxxxxxxxxxxxx
          type: string
      required:
        - request_id
      type: object
    ApiErrorDetail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Machine-readable issue code from the validator (e.g. zod issue
            code).
          example: invalid_string
          type: string
        field:
          description: Dot-path of the offending request field.
          example: recipient.email
          type: string
        message:
          description: Human-readable issue description.
          type: string
      required:
        - field
        - code
        - message
      type: object
    FilterRule:
      additionalProperties: false
      properties:
        note:
          description: >-
            Free-form caption for the rule (≤255 chars). UI-only metadata —
            never consulted at match time. `null` when absent.
          example: billing webhooks
          maxLength: 255
          type:
            - string
            - 'null'
        pattern:
          description: >-
            Email address or bare domain name. Validated against RFC 5321/1035
            regexes. The `*@domain` wildcard spelling is accepted and normalised
            to the bare domain (matching is by exact address or sender domain).
          example: partner.com
          type: string
        type:
          description: Rule type
          enum:
            - allow
            - deny
          type: string
      required:
        - type
        - pattern
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      description: >-
        Sendmux API key. Use a root API key for Management API routes, or a
        mailbox credential for Mailbox API routes. Obtain keys from the
        dashboard under API Keys.
      scheme: bearer
      type: http

````