# List Domains Eligible for Renewal

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/domains/renewal-soon:
    post:
      summary: List Domains Eligible for Renewal
      deprecated: false
      description: >-
        Use this endpoint to retrieve a paginated list of domains expiring
        within the next 2 months. You can filter results by domain name, tags,
        or status.


        Note: High-reputation domains and pre-warmed domains are not eligible
        for renewal through this endpoint.
      tags:
        - domains
      parameters:
        - name: page
          in: query
          description: 'Page number (default: 1)'
          required: false
          schema:
            type: number
        - name: limit
          in: query
          description: 'Results per page (default: 50)'
          required: false
          schema:
            type: number
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example: YOUR_API_KEY
          schema:
            type: string
        - name: x-workspace-key
          in: header
          description: ''
          required: false
          example: workspace_id
          schema:
            type: string
        - name: x-service-provider
          in: header
          description: ''
          required: false
          example: GOOGLE
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contains:
                  type: string
                  description: Filter domains by name substring
                tagIds:
                  type: array
                  items:
                    type: string
                  description: Filter by tag IDs
              x-apidog-orders:
                - contains
                - tagIds
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      totalCount:
                        type: integer
                      totalPages:
                        type: integer
                      currentPage:
                        type: integer
                      domains:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            domain:
                              type: string
                            status:
                              type: string
                            createdAt:
                              type: string
                            registeredOn:
                              type: string
                            expireOn:
                              type: string
                            serviceProvider:
                              type: string
                            assignedMailboxesCount:
                              type: integer
                            workspace:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                              required:
                                - id
                                - name
                              x-apidog-orders:
                                - id
                                - name
                          x-apidog-orders:
                            - id
                            - domain
                            - status
                            - createdAt
                            - registeredOn
                            - expireOn
                            - serviceProvider
                            - assignedMailboxesCount
                            - workspace
                    required:
                      - totalCount
                      - totalPages
                      - currentPage
                      - domains
                    x-apidog-orders:
                      - totalCount
                      - totalPages
                      - currentPage
                      - domains
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Domains fetched successfully
                data:
                  totalCount: 12
                  totalPages: 1
                  currentPage: 1
                  domains:
                    - id: uuid
                      domain: example.com
                      status: ACTIVE
                      createdAt: '2024-01-01T00:00:00.000Z'
                      registeredOn: '2024-01-01T00:00:00.000Z'
                      expireOn: '2026-05-01T00:00:00.000Z'
                      serviceProvider: GOOGLE
                      assignedMailboxesCount: 3
                      workspace:
                        id: uuid
                        name: My Workspace
          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-33616824-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```