Search Account Domains

This document contains details for the GET /api/v1/account/{accountUuid}/domain endpoint, including pagination, search filters, and a response example.

Use this endpoint to search account domains. You can filter the results by status, keyword, and pagination settings.

Endpoint

Method

GET

Request URL

/api/v1/account/{accountUuid}/domain

Headers

Authorization *

Bearer TOKEN

Content-Type

application/json

Request

accountUuid *

Target account UUID

limit

Limit records, max is 1000, default 25

offset

Offset records, default 0

keyword

Part of domain name for search

status

Domain status to search. Can be on of (UNVERIFIED, ACTIVE, INACTIVE) and virtual status VERIFIED, which means ACTIVE + INACTIVE

Response example

{
  "data": [
    {
      "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "domain": "google.com",
      "status": "ACTIVE",
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "verifyInfo": {
        "domain": "_whitedoc-verify",
        "value": "abc123"
      },
      "verifyMethod": "DNS_TXT_RECORD"
    },
    {
      "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "domain": "facebook.com",
      "status": "ACTIVE",
      "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa5",
      "verifyInfo": {
        "domain": "_whitedoc-verify",
        "value": "abc124"
      },
      "verifyMethod": "DNS_TXT_RECORD"
    }
  ],
  "numberOfElements": 2,
  "sizeRequested": 25,
  "totalElements": 2
}

Last updated