List domains

POST

https://api.inboxkit.com/v1/api/domains/list

Maintainer:Not configured

Get a paginated list of domains for the workspace

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Domains list retrieved successfully

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.inboxkit.com/v1/api/domains/list' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 1,
    "limit": 10,
    "keywords": "string",
    "uids": [
        "string"
    ],
    "status": [
        "string"
    ],
    "nameserver_match_status": [
        "matched"
    ]
}'

Response Example

{
    "error": false,
    "message": "Domains retrieved successfully",
    "domains": [
        {
            "uid": "string",
            "name": "example.com",
            "status": "active",
            "registration_years": 0,
            "created_at": "2019-08-24T14:15:22.123Z",
            "tld": "string",
            "price": "string",
            "renewal_date": "string",
            "whois_privacy": true,
            "forwarding_url": "string",
            "forwarding_email": "string",
            "enable_mask_forwarding": true,
            "dmarc_email": "string",
            "catch_all_email": "string",
            "nameservers": [
                "string"
            ],
            "nameserver_match_status": "matched",
            "actual_nameservers": [
                "string"
            ],
            "last_nameserver_check": "2019-08-24T14:15:22.123Z",
            "assigned_mailboxes": "string",
            "available_mailboxes": "string",
            "cf_zone_id": "string",
            "tags": [
                "string"
            ],
            "payment_type": "string",
            "connection_type": "string",
            "createdAt": "string",
            "updatedAt": "string"
        }
    ],
    "total": 0,
    "pages": 0,
    "current_page": 0,
    "limit": 0,
    "status_counts": {
        "active": 45,
        "pending": 5,
        "not_connected": 3,
        "expired_propagation": 1
    },
    "nameserver_status_counts": {
        "matched": 40,
        "moved": 3,
        "pending": 5,
        "unknown": 2
    }
}

Modified at 2026-01-27 10:01:11

List assignable domains