# Get placement test orders

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v2/placement-tests/orders:
    get:
      summary: Get placement test orders
      deprecated: false
      description: Get placement test orders with their results, aggregated by cart order.
      tags:
        - placement test
      parameters:
        - name: page
          in: query
          description: ''
          required: false
          example: '1'
          schema:
            type: string
        - name: limit
          in: query
          description: ''
          required: false
          example: '10'
          schema:
            type: string
        - name: x-auth-zapmail
          in: header
          description: ''
          required: true
          example:
            - ''
          schema:
            type: array
            items:
              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:
                      orders:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            cartOrderId:
                              type: string
                            testName:
                              type: string
                            mailboxId:
                              type: string
                            mailboxEmail:
                              type: string
                            status:
                              type: string
                            billingCycle:
                              type: string
                            subscriptionId:
                              type: string
                            results:
                              type: object
                              properties:
                                inboxRate:
                                  type: number
                                spamRate:
                                  type: number
                                score:
                                  type: number
                              required:
                                - inboxRate
                                - spamRate
                                - score
                              x-apidog-orders:
                                - inboxRate
                                - spamRate
                                - score
                            seedAccounts:
                              type: array
                              items:
                                type: string
                            spamassassin:
                              type: boolean
                            blacklist:
                              type: boolean
                            createdAt:
                              type: string
                            completedAt:
                              type: string
                              nullable: true
                          required:
                            - id
                            - cartOrderId
                            - testName
                            - mailboxId
                            - mailboxEmail
                            - status
                            - billingCycle
                            - seedAccounts
                            - spamassassin
                            - blacklist
                            - createdAt
                            - completedAt
                          x-apidog-orders:
                            - id
                            - cartOrderId
                            - testName
                            - mailboxId
                            - mailboxEmail
                            - status
                            - billingCycle
                            - subscriptionId
                            - results
                            - seedAccounts
                            - spamassassin
                            - blacklist
                            - createdAt
                            - completedAt
                      pagination:
                        type: object
                        properties:
                          currentPage:
                            type: integer
                          totalPages:
                            type: integer
                          totalCount:
                            type: integer
                          limit:
                            type: integer
                          hasNextPage:
                            type: boolean
                          hasPreviousPage:
                            type: boolean
                        required:
                          - currentPage
                          - totalPages
                          - totalCount
                          - limit
                          - hasNextPage
                          - hasPreviousPage
                        x-apidog-orders:
                          - currentPage
                          - totalPages
                          - totalCount
                          - limit
                          - hasNextPage
                          - hasPreviousPage
                    required:
                      - orders
                      - pagination
                    x-apidog-orders:
                      - orders
                      - pagination
                required:
                  - status
                  - message
                  - data
                x-apidog-orders:
                  - status
                  - message
                  - data
              example:
                status: 200
                message: Placement test orders retrieved successfully
                data:
                  orders:
                    - id: order_abc123
                      cartOrderId: cart_xyz789
                      testName: Monthly Test - December 2024
                      mailboxId: mailbox_def456
                      mailboxEmail: user@example.com
                      status: COMPLETED
                      billingCycle: MONTHLY
                      subscriptionId: sub_1AbcDefGhiJklMnop
                      results:
                        inboxRate: 88.5
                        spamRate: 11.5
                        score: 85.2
                      seedAccounts:
                        - google
                        - microsoft365
                      spamassassin: true
                      blacklist: true
                      createdAt: '2024-12-01T10:00:00.000Z'
                      completedAt: '2024-12-01T10:45:00.000Z'
                    - id: order_ghi789
                      cartOrderId: cart_uvw345
                      testName: Weekly Test
                      mailboxId: mailbox_jkl012
                      mailboxEmail: sales@example.com
                      status: PENDING
                      billingCycle: ONE_TIME
                      seedAccounts:
                        - google
                        - microsoft365
                      spamassassin: true
                      blacklist: true
                      createdAt: '2024-12-15T14:30:00.000Z'
                      completedAt: null
                  pagination:
                    currentPage: 1
                    totalPages: 5
                    totalCount: 48
                    limit: 10
                    hasNextPage: true
                    hasPreviousPage: false
          headers: {}
          x-apidog-name: Success
        '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-25779469-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.zapmail.ai/api
    description: Prod Env
security: []

```
