Retrieve All 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 --request GET 'https://api.zapmail.ai/api/v2/domains?contains&page&limit' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Domains fetched successfully",
    "data": {
        "totalSearchedCount": 2,
        "currentPage": 1,
        "nextPage": 2,
        "totalPages": 1,
        "domains": [
            {
                "id": "64e71b99-bc07-4b5d-90b6-6abc0120c08c",
                "domain": "abc.com",
                "status": "ACTIVE",
                "createdAt": "2024-07-29T14:13:35.168Z",
                "updatedAt": "2024-07-29T14:14:57.045Z",
                "forwardTo": null,
                "forwardToAddedOnReseller": false,
                "dmarcEmail": null,
                "dmarcEmailAddedToReseller": false,
                "forwardingEmail": null,
                "forwardingEmailAdded": false,
                "catchAllEmail": null,
                "catchAllEmailAdded": false,
                "nameServers": null,
                "assignedMailboxesCount": "0"
            },
            {
                "id": "35649ec0-a54e-4ea0-8d3d-05df47690326",
                "domain": "xyz.com",
                "status": "ACTIVE",
                "createdAt": "2024-07-12T10:01:31.028Z",
                "updatedAt": "2024-07-26T06:53:10.551Z",
                "forwardTo": "https://stage.ai",
                "forwardToAddedOnReseller": true,
                "dmarcEmail": "john@company.com",
                "dmarcEmailAddedToReseller": true,
                "forwardingEmail": "john@company.com",
                "forwardingEmailAdded": false,
                "catchAllEmail": "john@company.com",
                "catchAllEmailAdded": false,
                "nameServers": [
                    "adele.ns.cloudflare.com",
                    "rose.ns.cloudflare.com"
                ],
                "assignedMailboxesCount": "1"
            }
        ]
    }
}