# List Assignable Domains

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/domains/assignable:
    get:
      summary: List Assignable Domains
      deprecated: false
      description: >-
        This endpoint provides a list of domains to which you can assign
        mailboxes.
      tags:
        - domains
      parameters:
        - name: contains
          in: query
          description: Filters domains that contain the specified substring.
          required: false
          example: zap
          schema:
            type: string
        - name: page
          in: query
          description: Specifies the page number for paginated results.
          required: false
          example: '1'
          schema:
            type: string
        - name: limit
          in: query
          description: Number of domains returned per page
          required: false
          example: '20'
          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:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      totalSearchedCount:
                        type: integer
                      currentPage:
                        type: integer
                      nextPage:
                        type: integer
                      totalPages:
                        type: integer
                      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: 'null'
                            forwardToAddedOnReseller:
                              type: boolean
                            dmarcEmail:
                              type: 'null'
                            dmarcEmailAddedToReseller:
                              type: boolean
                            assignedMailboxesCount:
                              type: string
                            mailboxes:
                              type: array
                              items:
                                type: string
                          x-apidog-orders:
                            - id
                            - workspaceId
                            - domain
                            - status
                            - createdAt
                            - updatedAt
                            - forwardTo
                            - forwardToAddedOnReseller
                            - dmarcEmail
                            - dmarcEmailAddedToReseller
                            - assignedMailboxesCount
                            - mailboxes
                    required:
                      - totalSearchedCount
                      - currentPage
                      - nextPage
                      - totalPages
                      - domains
                    x-apidog-orders:
                      - totalSearchedCount
                      - currentPage
                      - nextPage
                      - totalPages
                      - domains
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Domains fetched successfully
                data:
                  totalSearchedCount: 1
                  currentPage: 1
                  nextPage: 2
                  totalPages: 1
                  domains:
                    - id: e439f190-632c-40cd-98a7-f1f3f1cc7a05
                      workspaceId: 0e027scf-frd2-443d-9c3c-2d157ff6sfda
                      domain: abc.com
                      status: ACTIVE
                      createdAt: '2025-03-13T14:38:07.579Z'
                      updatedAt: '2025-06-27T12:01:01.359Z'
                      forwardTo: null
                      forwardToAddedOnReseller: false
                      dmarcEmail: null
                      dmarcEmailAddedToReseller: false
                      assignedMailboxesCount: '0'
                      mailboxes: []
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: domains
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-13520727-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```
