# Get eligible domains

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/dns-shield/eligible-domains:
    get:
      summary: Get eligible domains
      deprecated: false
      description: >-
        Retrieve a paginated list of domains that are eligible for DNS Shield
        protection. This endpoint helps you identify which of your domains can
        be protected with DNS Shield before making a purchase.
      tags:
        - dns shield
      parameters:
        - name: page
          in: query
          description: ''
          required: true
          example: ' 1'
          schema:
            type: string
        - name: limit
          in: query
          description: ''
          required: true
          example: ' 10'
          schema:
            type: string
        - name: tagIds
          in: query
          description: ''
          required: false
          example:
            - 550e8400-e29b-41d4-a716-446655440000
          schema:
            type: array
            items:
              type: string
        - name: contains
          in: query
          description: ''
          required: false
          example: ' "example.com"'
          schema:
            type: string
        - name: status
          in: query
          description: ''
          required: false
          example: ' "ACTIVE"'
          schema:
            type: string
        - name: mailboxIds
          in: query
          description: ''
          required: false
          example: ' ["123e4567-e89b-12d3-a456-426614174000"]'
          schema:
            type: string
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      totalCount:
                        type: integer
                      totalPages:
                        type: integer
                      currentPage:
                        type: integer
                      hasNextPage:
                        type: boolean
                      hasPreviousPage:
                        type: boolean
                      nextPage:
                        type: integer
                      previousPage:
                        type: 'null'
                      domains:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            workspaceId:
                              type: string
                            domain:
                              type: string
                            status:
                              type: string
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            forwardTo:
                              type: string
                            forwardToAddedOnReseller:
                              type: boolean
                            dmarcEmail:
                              type: string
                            dmarcEmailAddedToReseller:
                              type: boolean
                            forwardingEmail:
                              type: string
                            forwardingEmailAdded:
                              type: boolean
                            catchAllEmail:
                              type: string
                            catchAllEmailAdded:
                              type: boolean
                            nameServers:
                              type: array
                              items:
                                type: string
                            unusedDomainNotification:
                              type: boolean
                            dnsManagedBy:
                              type: string
                            maskForwarding:
                              type: boolean
                            isWarmedUp:
                              type: boolean
                            autoRenew:
                              type: boolean
                            registeredOn:
                              type: string
                            expireOn:
                              type: string
                            dnsAuthenticationInProgress:
                              type: boolean
                            cloudflareCredentialsId:
                              type: string
                            expectedNameServers:
                              type: array
                              items:
                                type: string
                            isaftermarket:
                              type: boolean
                            assignedMailboxesCount:
                              type: integer
                            transferRequired:
                              type: boolean
                            transferInternally:
                              type: boolean
                            isCloudflareConnected:
                              type: boolean
                            dnsShieldUpdateInProgress:
                              type: 'null'
                            dnsShieldEnabled:
                              type: boolean
                            dnsBoxInvalidNameServers:
                              type: boolean
                          x-apidog-orders:
                            - id
                            - workspaceId
                            - domain
                            - status
                            - createdAt
                            - updatedAt
                            - forwardTo
                            - forwardToAddedOnReseller
                            - dmarcEmail
                            - dmarcEmailAddedToReseller
                            - forwardingEmail
                            - forwardingEmailAdded
                            - catchAllEmail
                            - catchAllEmailAdded
                            - nameServers
                            - unusedDomainNotification
                            - dnsManagedBy
                            - maskForwarding
                            - isWarmedUp
                            - autoRenew
                            - registeredOn
                            - expireOn
                            - dnsAuthenticationInProgress
                            - cloudflareCredentialsId
                            - expectedNameServers
                            - isaftermarket
                            - assignedMailboxesCount
                            - transferRequired
                            - transferInternally
                            - isCloudflareConnected
                            - dnsShieldUpdateInProgress
                            - dnsShieldEnabled
                            - dnsBoxInvalidNameServers
                    required:
                      - totalCount
                      - totalPages
                      - currentPage
                      - hasNextPage
                      - hasPreviousPage
                      - nextPage
                      - previousPage
                      - domains
                    x-apidog-orders:
                      - totalCount
                      - totalPages
                      - currentPage
                      - hasNextPage
                      - hasPreviousPage
                      - nextPage
                      - previousPage
                      - domains
                required:
                  - success
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - success
                  - status
                  - message
                  - data
              example:
                success: true
                status: 200
                message: Domains fetched successfully
                data:
                  totalCount: 15
                  totalPages: 2
                  currentPage: 1
                  hasNextPage: true
                  hasPreviousPage: false
                  nextPage: 2
                  previousPage: null
                  domains:
                    - id: domain-uuid
                      workspaceId: workspace-uuid
                      domain: example.com
                      status: ACTIVE
                      createdAt: '2024-01-15T10:30:00.000Z'
                      updatedAt: '2024-01-15T10:30:00.000Z'
                      forwardTo: forward@email.com
                      forwardToAddedOnReseller: true
                      dmarcEmail: dmarc@email.com
                      dmarcEmailAddedToReseller: true
                      forwardingEmail: forwarding@email.com
                      forwardingEmailAdded: true
                      catchAllEmail: catchall@email.com
                      catchAllEmailAdded: true
                      nameServers:
                        - ns1.provider.com
                        - ns2.provider.com
                      unusedDomainNotification: false
                      dnsManagedBy: CLOUDFLARE
                      maskForwarding: false
                      isWarmedUp: false
                      autoRenew: true
                      registeredOn: '2023-01-15T00:00:00.000Z'
                      expireOn: '2025-01-15T00:00:00.000Z'
                      dnsAuthenticationInProgress: false
                      cloudflareCredentialsId: cf-cred-uuid
                      expectedNameServers:
                        - ns1.expected.com
                        - ns2.expected.com
                      isaftermarket: false
                      assignedMailboxesCount: 5
                      transferRequired: true
                      transferInternally: false
                      isCloudflareConnected: true
                      dnsShieldUpdateInProgress: null
                      dnsShieldEnabled: false
                      dnsBoxInvalidNameServers: false
          headers: {}
          x-apidog-name: Success
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                      errors:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          x-apidog-orders:
                            - field
                            - message
                    required:
                      - errorId
                      - errors
                    x-apidog-orders:
                      - errorId
                      - errors
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 400
                message: Validation error
                data:
                  errorId: unique-error-id
                  errors:
                    - field: tagIds
                      message: tagIds must be a valid array
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                    required:
                      - errorId
                    x-apidog-orders:
                      - errorId
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 401
                message: Invalid API key
                data:
                  errorId: unique-error-id
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      errorId:
                        type: string
                    required:
                      - errorId
                    x-apidog-orders:
                      - errorId
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 500
                message: Internal server error
                data:
                  errorId: unique-error-id
          headers: {}
          x-apidog-name: Internal Server Error
      security: []
      x-apidog-folder: dns shield
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-25781361-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```