List domains

Request Information
URL GET {{basepath}}/domain?start=0&limit=10
CategoryREPP Domain

Description

Lists domains in your account

Expects a DomainListRequest object.

Returns a DomainListResponse object.

Query parameters
name%domain%The domainname to search for. use % as a wildcard
autorenewtrue
crmId123%Your crm id , if you have marked it as such
start0
limit10
status%pending%

Example responses

List 10 domains
Request Method & URL
GET {{basepath}}/domain?start=0&limit=10
Query parameters
start0
limit10
Response Code:
200 OK
Response Body:
{
    "responseId": "mapi1_b49b8765b545b8c546ff2bc30dae5d7d22e71ecd",
    "status": "ok",
    "message": "The domains are attached",
    "listItemCount": 143,
    "domains": [
        {
            "name": "test-domain-2024-01-08.cw",
            "status": [
                "pendingValidation"
            ],
            "autorenew": true,
            "crmId": "1234",
            "metadata": {
                "flooble": "florp",
                "dinglebop": true
            }
        },
        {
            "name": "test-domain-2024-01-08-01.cw",
            "status": [
                "pendingValidation"
            ],
            "autorenew": true
        },
        {
            "name": "johntest-2018-05-14-1.com",
            "status": [
                "ok",
                "pendingDelete"
            ],
            "autorenew": true
        },
        {
            "name": "johntest-ral-2018-10-29-1.frl",
            "status": [
                "ok",
                "pendingDelete"
            ],
            "autorenew": true
        },
        {
            "name": "johntest-ral-2019-02-07-1.com",
            "status": [
                "ok"
            ],
            "autorenew": false
        },
        {
            "name": "john-ote-transfer-2019-02-08-01.frl",
            "status": [
                "ok"
            ],
            "autorenew": true
        },
        {
            "name": "proptest-2019-04-03-01.com",
            "status": [
                "ok"
            ],
            "autorenew": true
        },
        {
            "name": "test-auto-change-on-delete-2020-08-21.es",
            "status": [
                "ok",
                "pendingDelete"
            ],
            "autorenew": true
        },
        {
            "name": "met-1k4090m5f69e7f929928.nl",
            "status": [
                "ok",
                "pendingDelete"
            ],
            "autorenew": true
        },
        {
            "name": "testcontact-delete-2021-06-23-01.nl",
            "status": [
                "ok",
                "pendingDelete"
            ],
            "autorenew": true
        }
    ]
}