Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-213564581.3 MB

3bf93dafc002

Hosting: Websites

List websites

Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client.

This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you.

Each website includes a website_type field describing the type of website detected on the underlying platform (wordpress, builder, horizons, nodejs, or other). Some fields, such as vhost_type, username, and root_directory, only apply to CloudLinux websites and are null for other platforms.

Use website_types to list only websites of a given detected type, e.g. only WordPress websites (website_types=wordpress) or only Node.js websites (website_types=nodejs). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results.

get/api/hosting/v1/websites

Query parameters

pageinteger
Example:1

Page number

per_pageinteger
Example:25

Number of items per page

usernamestring nullable
Example:cl_user123

Filter by specific username

order_idinteger nullable
Example:123

Order ID

is_enabledboolean nullable
Example:true

Filter by enabled status

domainstring nullable
Example:example.com

Filter by domain name (case-insensitive substring match)

website_typesstring[] nullable

Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.

[
  "wordpress",
  "nodejs"
]

Response

Success response

Example response

{
  "data": [
    {
      "domain": "example.com",
      "vhost_type": "main",
      "is_enabled": true,
      "username": "cl_user123",
      "client_id": 67890,
      "order_id": 12345,
      "created_at": "2024-01-15T10:30:00+00:00",
      "root_directory": "/home/u123456798/domains/example.com/public_html",
      "parent_domain": "parent.com",
      "website_type": "wordpress",
      "horizons_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 100
  }
}