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

# List all domains

> Get paginated list of domains for authenticated user with optional filtering.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/inbound/openapi.documented.yml get /api/e2/domains
openapi: 3.1.0
info:
  title: Inbound Email API
  description: >+

    # Inbound API


    The Inbound API allows you to manage email infrastructure programmatically -
    domains, email addresses, webhooks, and more.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```bash

    curl -H "Authorization: Bearer YOUR_API_KEY" \
      https://inbound.new/api/e2/domains
    ```


    ## Base URL


    ```

    https://inbound.new/api/e2

    ```


    ## Quick Start


    1. **Create a domain** - Register your domain with Inbound

    2. **Configure DNS** - Add the provided DNS records to your domain

    3. **Create an email address** - Set up addresses to receive emails

    4. **Create an endpoint** - Configure where emails are delivered (webhook,
    forwarding, etc.)

  version: 2.0.0
servers:
  - url: https://inbound.new
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Webhooks
    description: Webhooks sent by Inbound to your configured endpoints when events occur.
  - name: Emails
    description: >-
      Send, list, and manage emails. Supports immediate sending, scheduling,
      replies, and retry functionality.
  - name: Mail
    description: >-
      Inbox and thread views for received emails. Filter by domain, address, or
      search.
  - name: Domains
    description: >-
      Manage domains for sending and receiving emails. Domains must be verified
      via DNS before use.
  - name: Endpoints
    description: >-
      Configure where incoming emails are delivered - webhooks, email
      forwarding, or custom handlers.
  - name: Email Addresses
    description: Create and manage email addresses on your verified domains.
  - name: Attachments
    description: Download email attachments using authenticated requests.
paths:
  /api/e2/domains:
    get:
      tags:
        - Domains
      summary: List all domains
      description: >-
        Get paginated list of domains for authenticated user with optional
        filtering.
      operationId: getApiE2Domains
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            minimum: 1
            maximum: 100
            default: 50
            anyOf:
              - format: integer
                default: 0
                type: string
              - minimum: 1
                maximum: 100
                default: 50
                type: integer
        - name: offset
          in: query
          required: false
          schema:
            minimum: 0
            default: 0
            anyOf:
              - format: integer
                default: 0
                type: string
              - minimum: 0
                default: 0
                type: integer
        - name: status
          in: query
          required: false
          schema:
            enum:
              - pending
              - verified
              - failed
            type: string
        - name: canReceive
          in: query
          required: false
          schema:
            enum:
              - 'true'
              - 'false'
            type: string
        - name: check
          in: query
          required: false
          schema:
            enum:
              - 'true'
            type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        domain:
                          type: string
                        status:
                          type: string
                        canReceiveEmails:
                          type: boolean
                        hasMxRecords:
                          type: boolean
                        domainProvider:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        providerConfidence:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        lastDnsCheck:
                          nullable: true
                          anyOf:
                            - format: date-time
                              type: string
                            - type: 'null'
                        lastSesCheck:
                          nullable: true
                          anyOf:
                            - format: date-time
                              type: string
                            - type: 'null'
                        isCatchAllEnabled:
                          type: boolean
                        catchAllEndpointId:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        mailFromDomain:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        mailFromDomainStatus:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        mailFromDomainVerifiedAt:
                          nullable: true
                          anyOf:
                            - format: date-time
                              type: string
                            - type: 'null'
                        receiveDmarcEmails:
                          type: boolean
                        createdAt:
                          format: date-time
                          type: string
                        updatedAt:
                          format: date-time
                          type: string
                        userId:
                          type: string
                        stats:
                          type: object
                          properties:
                            totalEmailAddresses:
                              type: number
                            activeEmailAddresses:
                              type: number
                            hasCatchAll:
                              type: boolean
                          required:
                            - totalEmailAddresses
                            - activeEmailAddresses
                            - hasCatchAll
                        catchAllEndpoint:
                          nullable: true
                          anyOf:
                            - type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                type:
                                  type: string
                                isActive:
                                  type: boolean
                              required:
                                - id
                                - name
                                - type
                                - isActive
                            - type: 'null'
                        verificationCheck:
                          type: object
                          properties:
                            dnsRecords:
                              type: array
                              items:
                                type: object
                                properties:
                                  type:
                                    type: string
                                  name:
                                    type: string
                                  value:
                                    type: string
                                  isVerified:
                                    type: boolean
                                  error:
                                    type: string
                                required:
                                  - type
                                  - name
                                  - value
                                  - isVerified
                            sesStatus:
                              type: string
                            isFullyVerified:
                              type: boolean
                            lastChecked:
                              format: date-time
                              type: string
                          required:
                            - dnsRecords
                            - sesStatus
                            - isFullyVerified
                            - lastChecked
                      required:
                        - id
                        - domain
                        - status
                        - canReceiveEmails
                        - hasMxRecords
                        - domainProvider
                        - providerConfidence
                        - lastDnsCheck
                        - lastSesCheck
                        - isCatchAllEnabled
                        - catchAllEndpointId
                        - mailFromDomain
                        - mailFromDomainStatus
                        - mailFromDomainVerifiedAt
                        - receiveDmarcEmails
                        - createdAt
                        - updatedAt
                        - userId
                        - stats
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: number
                      offset:
                        type: number
                      total:
                        type: number
                      hasMore:
                        type: boolean
                    required:
                      - limit
                      - offset
                      - total
                      - hasMore
                required:
                  - data
                  - pagination
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Inbound from 'inboundemail';

            const client = new Inbound({
              apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
            });

            const domains = await client.domains.list();

            console.log(domains.data);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Inbound API key. Include it in the Authorization header as: Bearer
        <your-api-key>

````