Retrieve All Domains

This endpoint retrieves a list of all domains.

Query Parameters

contains

Type: string

Description: A search filter to return domains that match the specified criteria. The value can be any string, and only domains containing this string will be returned.

Example:

contains=example

page

Type: number

Description: The page number for paginating the results. This allows you to retrieve results in multiple pages, helping to manage large sets of data.

Example:

page=2

Notes

The contains parameter is optional and can be omitted if no filtering is required.

The page parameter is used for pagination and can be adjusted to retrieve different pages of results. Ensure to pass the correct page number as required by your use case.

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"
            }
        ]
    }
}

Retrieve All Domains

Query Parameters

contains

page

Notes

Request

Request Code Samples

Responses

Retrieve All Domains

Query Parameters#

contains#

page#

Notes#

Request

Request Code Samples

Responses

Query Parameters

contains

page

Notes