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

# [Email Routing] Get the email routing of a zone

> Read whether mail sent to the zone's domain is forwarded, the forwarding rules, the catch-all and the organization's destination addresses with their verification status. `available` is false, with `unavailable_reason`, when the zone is not provisioned yet (`zone_not_provisioned`) or lives in your own Cloudflare account (`client_cloudflare_account`), where email routing is managed in its dashboard.



## OpenAPI

````yaml https://api.onetsolutions.net/schema get /v1/organizations/{organization_id}/projects/{project_id}/dns-zones/{id}/email-routing
openapi: 3.0.3
info:
  title: OnetSolutions API
  version: v1 (v1)
  description: >

    ## Overview


    The OnetSolutions API provides programmatic access to manage your cloud
    infrastructure, domains, and web hosting services.


    ## Authentication


    All API requests require authentication using one of the following methods:


    - **JWT Token**: Obtain a token via login endpoints and include it in the
    `Authorization: Bearer <token>` header

    - **API Key**: Generate an API key from your account settings and use it as
    `Authorization: Bearer sk-onetsolutions-...`


    ## Rate Limiting


    API requests are rate-limited to ensure fair usage:

    - **Anonymous**: 60 requests per minute, per client IP address

    - **Authenticated**: 5000 requests per hour, per user


    Some endpoints, such as login and sign-up, apply stricter limits of their
    own.

    A request over the limit gets a `429` response whose `Retry-After` header
    gives the wait in seconds.


    ## Pagination


    Most list endpoints return paginated results. Use the `page` and `page_size`
    query parameters

    (at most 100 results per page). The response carries `count`, `next`,
    `previous`, `page`, `page_size`,

    `total_pages` and the `results` themselves.


    ## Error Handling


    The API uses standard HTTP status codes:

    - `200` Success

    - `201` Created

    - `204` No Content

    - `400` Bad Request

    - `401` Unauthorized

    - `403` Forbidden

    - `404` Not Found

    - `409` Conflict

    - `429` Too Many Requests

    - `500` Internal Server Error

    - `503` Service Unavailable


    Error responses carry a JSON body with `detail`, a human-readable message,
    and `code`, a stable

    machine-readable error code. Some errors add `context` with structured
    details, and `error`

    repeats `detail` for older clients. A request whose fields fail validation
    gets a `400` whose body maps each

    invalid field to its list of messages. A few older endpoints still answer
    with `error` alone.
servers:
  - url: https://api.onetsolutions.net
    description: Production
security: []
tags:
  - name: Authentication
    description: >-
      Login, passwordless authentication, MFA, OAuth providers, and token
      management.
  - name: Organizations
    description: >-
      Organization management, members, roles, modules, audit logs, and
      notification settings.
  - name: Projects
    description: Project management, team members, and project-scoped resources.
  - name: Compute
    description: >-
      Cloud instances, volumes, snapshots, backups, VPCs, firewalls, SSH keys,
      uptime monitors, and instance tasks.
  - name: Billing
    description: >-
      Shopping cart, orders, invoices, payments, payment methods, gateways,
      promo codes, and balance management.
  - name: Domains
    description: >-
      Domain availability, registration, transfers, DNS zones, DNS records, and
      TLD information.
  - name: Web Hosting
    description: >-
      cPanel-based web hosting, emails, databases, subdomains, FTP accounts,
      addon domains, and SSL certificates.
paths:
  /v1/organizations/{organization_id}/projects/{project_id}/dns-zones/{id}/email-routing:
    get:
      tags:
        - Domains
      summary: '[Email Routing] Get the email routing of a zone'
      description: >-
        Read whether mail sent to the zone's domain is forwarded, the forwarding
        rules, the catch-all and the organization's destination addresses with
        their verification status. `available` is false, with
        `unavailable_reason`, when the zone is not provisioned yet
        (`zone_not_provisioned`) or lives in your own Cloudflare account
        (`client_cloudflare_account`), where email routing is managed in its
        dashboard.
      operationId: get_dns_zone_email_routing
      parameters:
        - in: path
          name: id
          schema:
            type: string
          description: The unique identifier (UUID) of the DNS zone
          required: true
        - in: path
          name: organization_id
          schema:
            type: string
            format: uuid
          required: true
        - in: path
          name: project_id
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSZoneEmailRouting'
          description: Email routing of the zone
        '400':
          description: 'The email routing could not be read (code: domain_operation_failed)'
        '401':
          description: Authentication credentials were not provided or are invalid
        '403':
          description: You do not have permission to perform this action on this DNS zone
        '404':
          description: DNS zone not found or does not belong to the specified project
        '503':
          description: The DNS provider is unavailable. Retry later
      security:
        - BearerAuth: []
components:
  schemas:
    DNSZoneEmailRouting:
      type: object
      properties:
        provider:
          type: string
        available:
          type: boolean
          description: Whether email routing can be managed on this zone here
        unavailable_reason:
          enum:
            - client_cloudflare_account
            - zone_not_provisioned
            - zone_not_active
            - null
          type: string
          description: |-
            * `client_cloudflare_account` - client_cloudflare_account
            * `zone_not_provisioned` - zone_not_provisioned
            * `zone_not_active` - zone_not_active
          x-spec-enum-id: fb19a9bf51737aef
          nullable: true
        enabled:
          type: boolean
        status:
          type: string
          nullable: true
          description: 'Email routing status: ready, unconfigured, misconfigured, ...'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/EmailRoutingRule'
        catch_all:
          allOf:
            - $ref: '#/components/schemas/EmailRoutingCatchAll'
          nullable: true
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/EmailRoutingDestination'
      required:
        - available
        - catch_all
        - destinations
        - enabled
        - provider
        - rules
        - status
        - unavailable_reason
    EmailRoutingRule:
      type: object
      properties:
        id:
          type: string
        address:
          type: string
          format: email
          description: The address of the zone's domain this rule receives mail for
        destination:
          type: string
          format: email
          description: The mailbox the mail is forwarded to
        enabled:
          type: boolean
      required:
        - address
        - destination
        - enabled
        - id
    EmailRoutingCatchAll:
      type: object
      properties:
        enabled:
          type: boolean
        action:
          enum:
            - forward
            - drop
          type: string
          description: |-
            * `forward` - forward
            * `drop` - drop
          x-spec-enum-id: 661659ca5c8dc59e
        destination:
          type: string
          format: email
          nullable: true
          description: The mailbox mail is forwarded to, if any
      required:
        - action
        - destination
        - enabled
    EmailRoutingDestination:
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        verified:
          type: boolean
          description: >-
            Whether the owner of the address confirmed it from the verification
            e-mail
      required:
        - email
        - id
        - verified
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use `Authorization: Bearer <token>` header. Token can be a JWT token or
        an API key (format: `sk-onetsolutions-...`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.