Zapmail
latest
  • latest
  • v1
  1. placement test
Zapmail
latest
  • latest
  • v1
  • Zapmail Docs
  • users
    • Retrieve User Details
      GET
  • workspaces
    • Retrieve all workspaces
      GET
    • Create new workspace
      POST
    • Update workspace
      PUT
  • billing
    • Add Billing Details
      POST
    • Update Billing Details
      PUT
  • mailbox
    • Retrieve All Mailboxes
      GET
    • Get Mailbox Details by ID
      GET
    • Assign New Mailboxes to Domains
      POST
    • Update mailbox
      PUT
    • Remove mailboxes on next renewal
      PUT
    • Get Authenticator code
      GET
    • Remove Mailboxes Instantly
      POST
    • Custom OAuth
      POST
  • payments & wallet
    • Add balance to wallet
      POST
    • Get wallet balance
      GET
    • Enable auto recharge
      POST
  • export
    • Export mailboxes
    • Add third party account details
    • Update third party account details
  • subscriptions
    • Get all subscriptions
    • Cancel subscription
    • Upgrade existing subscription
    • Purchase subscription
  • domains
    • Retrieve All Domains
    • List Assignable Domains
    • Add DMARC record
    • Add Domain forwarding
    • Get Name servers to connect domain
    • Verify Name Server Propagation
    • Connect Domain with Zapmail
    • Enable email forwarding
    • Remove email forwarding
    • Enable catch all emails
    • Remove catch all emails
    • Check DNS records
    • Remove unused domains
    • Get available domains for registration
    • Get domains purchase payment link
    • Get domain connection requests
    • Remove domain connection requests
    • Connect Domain with Zapmail (New)
    • Add Google Client ID to Domain
    • Get availability of multiple domain names.
    • Retrieve Domain Health Score
  • dns
    • Get dns records
    • Add dns records
    • Update dns records
    • Delete dns records
  • aged domains
    • Get available domains
    • Purchase aged domains
  • prewarmed domains
    • Get prewarmed domains
    • purchase prewarmed subscription
    • Assign prewarmed mailboxes
  • placement test
    • Get subscriptions
      GET
    • Get Overall Report
      GET
    • Get placement test orders
      GET
    • Get report by cart order id
      GET
    • Get Eligible Mailboxes for Placement Tests
      POST
    • Get Available Placement Test Credits
      GET
    • Purchase Placement Test
      POST
    • Purchase plan
      POST
  • dns shield
    • Get eligible domains
    • Get available slots
    • Get subscriptions
    • Get Allocated Domains for Subscription
    • Allocate Domains to DNS Shield
    • Purchase DNS Shield
    • Upgrade DNS Shield LTD Plan
    • Cancel subscription
  • Schemas
    • domain with filter
  1. placement test

Get placement test orders

Testing
GET
/v2/placement-tests/orders

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zapmail.ai/api/v2/placement-tests/orders?page=1&limit=10' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success
application/json
Body

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
    }
  }
}
Modified at 2025-12-24 13:02:48
Previous
Get Overall Report
Next
Get report by cart order id
Built with