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 the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
Query parameters
Page number
Number of items per page
Filter by specific username
Order ID
Filter by enabled status
Filter by domain name (exact match)
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
}
}