Get eligible domains

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.zapmail.ai/api/v2/dns-shield/eligible-domains?page= 1&limit= 10&tagIds=550e8400-e29b-41d4-a716-446655440000&contains= "example.com"&status= "ACTIVE"&mailboxIds= ["123e4567-e89b-12d3-a456-426614174000"]' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success

application/json

Body

Example

{
  "success": true,
  "status": 200,
  "message": "Domains fetched successfully",
  "data": {
    "totalCount": 15,
    "totalPages": 2,
    "currentPage": 1,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextPage": 2,
    "previousPage": null,
    "domains": [
      {
        "id": "domain-uuid",
        "workspaceId": "workspace-uuid",
        "domain": "example.com",
        "status": "ACTIVE",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z",
        "forwardTo": "forward@email.com",
        "forwardToAddedOnReseller": true,
        "dmarcEmail": "dmarc@email.com",
        "dmarcEmailAddedToReseller": true,
        "forwardingEmail": "forwarding@email.com",
        "forwardingEmailAdded": true,
        "catchAllEmail": "catchall@email.com",
        "catchAllEmailAdded": true,
        "nameServers": ["ns1.provider.com", "ns2.provider.com"],
        "unusedDomainNotification": false,
        "dnsManagedBy": "CLOUDFLARE",
        "maskForwarding": false,
        "isWarmedUp": false,
        "autoRenew": true,
        "registeredOn": "2023-01-15T00:00:00.000Z",
        "expireOn": "2025-01-15T00:00:00.000Z",
        "dnsAuthenticationInProgress": false,
        "cloudflareCredentialsId": "cf-cred-uuid",
        "expectedNameServers": ["ns1.expected.com", "ns2.expected.com"],
        "isaftermarket": false,
        "assignedMailboxesCount": 5,
        "transferRequired": true,
        "transferInternally": false,
        "isCloudflareConnected": true,
        "dnsShieldUpdateInProgress": null,
        "dnsShieldEnabled": false,
        "dnsBoxInvalidNameServers": false
      }
    ]
  }
}