# Get Eligible Mailboxes for Placement Tests

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/placement-tests/eligible-mailboxes:
    post:
      summary: Get Eligible Mailboxes for Placement Tests
      deprecated: false
      description: >-
        Retrieve a list of mailboxes eligible for placement testing. Allows
        filtering by status, tags, and search terms to find specific mailboxes.
      tags:
        - placement test
      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: status
          in: query
          description: ''
          required: false
          example: ACTIVE
          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: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      mailboxes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            email:
                              type: string
                            username:
                              type: string
                            domain:
                              type: string
                            domainId:
                              type: string
                            status:
                              type: string
                            isWarmedUp:
                              type: boolean
                            tags:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                required:
                                  - id
                                  - name
                                x-apidog-orders:
                                  - id
                                  - name
                            createdAt:
                              type: string
                            assignedOn:
                              type: string
                          required:
                            - id
                            - email
                            - username
                            - domain
                            - domainId
                            - status
                            - isWarmedUp
                            - tags
                            - createdAt
                            - assignedOn
                          x-apidog-orders:
                            - id
                            - email
                            - username
                            - domain
                            - domainId
                            - status
                            - isWarmedUp
                            - tags
                            - createdAt
                            - assignedOn
                      totalCount:
                        type: integer
                      eligibleCount:
                        type: integer
                    required:
                      - mailboxes
                      - totalCount
                      - eligibleCount
                    x-apidog-orders:
                      - mailboxes
                      - totalCount
                      - eligibleCount
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Eligible mailboxes retrieved successfully
                data:
                  mailboxes:
                    - id: mailbox_abc123
                      email: user1@example.com
                      username: user1
                      domain: example.com
                      domainId: domain_xyz789
                      status: ACTIVE
                      isWarmedUp: true
                      tags:
                        - id: tag_abc123
                          name: Sales Team
                      createdAt: '2024-10-01T10:00:00.000Z'
                      assignedOn: '2024-10-01T10:00:00.000Z'
                    - id: mailbox_def456
                      email: user2@example.com
                      username: user2
                      domain: example.com
                      domainId: domain_xyz789
                      status: ACTIVE
                      isWarmedUp: true
                      tags:
                        - id: tag_def456
                          name: Marketing
                      createdAt: '2024-10-15T14:30:00.000Z'
                      assignedOn: '2024-10-15T14:30:00.000Z'
                  totalCount: 25
                  eligibleCount: 2
          headers: {}
          x-apidog-name: Success
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        msg:
                          type: string
                        param:
                          type: string
                        location:
                          type: string
                      x-apidog-orders:
                        - msg
                        - param
                        - location
                required:
                  - status
                  - message
                  - errors
                x-apidog-orders:
                  - status
                  - message
                  - errors
              example:
                status: 400
                message: Validation failed
                errors:
                  - msg: page must be a positive integer
                    param: page
                    location: body
          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: API key is required
                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: placement test
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/797058/apis/api-25779778-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```