Get All Domains

Get Domains

This endpoint retrieves a list of domains with optional filtering and pagination.

Request Parameters

• page (number, optional): The page number for pagination.

• itemsPerPage (number, optional): The number of items to be included per page.

• id (string, optional): Filter by domain ID.

• id[] (string, optional): Filter by multiple domain IDs.

• name (string, optional): Filter by domain name.

• status (string, optional): Filter by domain status.

• status[] (string, optional): Filter by multiple domain statuses.

• createdAt[before] (string, optional): Filter by creation date before a specific date.

• createdAt[after] (string, optional): Filter by creation date after a specific date.

Response

The response of this request is a JSON object conforming to the following schema:

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "name": { "type": "string" },
          "status": { "type": "string" },
          "createdAt": { "type": "string", "format": "date-time" }
        }
      }
    },
    "totalCount": { "type": "number" }
  }
}

This schema represents an array of domain objects, each containing an ID, name, status, and creation date, along with a total count of domains.