# Get prewarmed domains

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/prewarmed-domains/get-domains:
    get:
      summary: Get prewarmed domains
      deprecated: false
      description: >-
        This endpoint retrieves available pre-warmed domains with their
        associated mailboxes. Pre-warmed domains are domains with warmed-up
        mailboxes that are ready for immediate use.
      tags:
        - prewarmed domains
      parameters:
        - name: page
          in: query
          description: ''
          required: true
          example: 1
          schema:
            type: integer
        - name: limit
          in: query
          description: ''
          required: true
          example: 10
          schema:
            type: integer
        - name: contains
          in: query
          description: ''
          required: false
          example: ''
          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:
                      domains:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            domain:
                              type: string
                            isSold:
                              type: boolean
                            domainId:
                              type: string
                            preWarmedUpMailboxes:
                              type: array
                              items:
                                type: object
                                properties:
                                  domainId:
                                    type: string
                                  domain:
                                    type: string
                                  mailbox:
                                    type: object
                                    properties:
                                      username:
                                        type: string
                                      firstName:
                                        type: string
                                      lastName:
                                        type: string
                                      createdAt:
                                        type: string
                                      profilePicture:
                                        type: string
                                        nullable: true
                                    required:
                                      - username
                                      - firstName
                                      - lastName
                                      - createdAt
                                      - profilePicture
                                    x-apidog-orders:
                                      - username
                                      - firstName
                                      - lastName
                                      - createdAt
                                      - profilePicture
                                required:
                                  - domainId
                                  - domain
                                  - mailbox
                                x-apidog-orders:
                                  - domainId
                                  - domain
                                  - mailbox
                            price:
                              type: number
                          x-apidog-orders:
                            - id
                            - domain
                            - isSold
                            - domainId
                            - preWarmedUpMailboxes
                            - price
                      total:
                        type: integer
                      totalDomainsUnsold:
                        type: integer
                      currentPage:
                        type: integer
                      nextPage:
                        type: integer
                      totalPages:
                        type: integer
                    required:
                      - domains
                      - total
                      - totalDomainsUnsold
                      - currentPage
                      - nextPage
                      - totalPages
                    x-apidog-orders:
                      - domains
                      - total
                      - totalDomainsUnsold
                      - currentPage
                      - nextPage
                      - totalPages
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Pre-warmed up domains fetched
                data:
                  domains:
                    - id: bf2317e5-b37-xxxx
                      domain: yourcompanynow.info
                      isSold: false
                      domainId: 923b513f-xxxx
                      preWarmedUpMailboxes:
                        - domainId: 923b513f-xxxx
                          domain: yourcompanynow.info
                          mailbox:
                            username: fd
                            firstName: Frank
                            lastName: D
                            createdAt: '2025-03-07T15:25:43.433Z'
                            profilePicture: null
                        - domainId: 923b513f-xxxx
                          domain: yourcompanynow.info
                          mailbox:
                            username: help
                            firstName: Esa
                            lastName: Käkelä
                            createdAt: '2024-07-12T10:03:08.566Z'
                            profilePicture: >-
                              https://zapmail.blob.core.windows.net/profile-picture/
                        - domainId: 923b513f-xxxx
                          domain: yourcompanynow.info
                          mailbox:
                            username: ad
                            firstName: alan
                            lastName: dsouza
                            createdAt: '2025-03-07T15:22:36.738Z'
                            profilePicture: null
                      price: 14.99
                  total: 1
                  totalDomainsUnsold: 1
                  currentPage: 1
                  nextPage: 2
                  totalPages: 1
          headers: {}
          x-apidog-name: Success
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 400
                message: Invalid pagination parameters
                errorId: uuid-v4-error-id
          headers: {}
          x-apidog-name: Bad Request
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 401
                message: Invalid API key
                errorId: uuid-v4-error-id
          headers: {}
          x-apidog-name: Unauthorized
        '500':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errorId:
                    type: string
                required:
                  - status
                  - message
                  - errorId
                x-apidog-orders:
                  - status
                  - message
                  - errorId
              example:
                status: 500
                message: Internal server error
                errorId: uuid-v4-error-id
          headers: {}
          x-apidog-name: Internal Server Error
      security: []
      x-apidog-folder: prewarmed domains
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-25774188-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```