Skip to main content
GET
/
orgs
/
{organization}
/
servers
/
{server}
/
sites
List sites for server
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
{
  "data": [
    {
      "id": "<string>",
      "type": "sites",
      "attributes": {
        "name": "<string>",
        "url": "<string>",
        "user": "<string>",
        "https": true,
        "web_directory": "<string>",
        "root_directory": "<string>",
        "aliases": [
          "<any>"
        ],
        "php_version": "<string>",
        "deployment_status": "<string>",
        "quick_deploy": true,
        "isolated": true,
        "shared_paths": {},
        "repository": {
          "provider": "<string>",
          "url": "<string>",
          "branch": "<string>",
          "status": "installed"
        },
        "database": "<string>",
        "maintenance_mode": {
          "enabled": true,
          "status": "disabling"
        },
        "zero_downtime_deployments": true,
        "deployment_script": "<string>",
        "wildcards": true,
        "app_type": "<string>",
        "uses_envoyer": true,
        "deployment_url": "<string>",
        "healthcheck_url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "tags": {
          "data": [
            {
              "type": "tags",
              "id": "<string>"
            }
          ]
        },
        "latestDeployment": {
          "data": {
            "type": "deployments",
            "id": "<string>"
          }
        }
      },
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "tags",
      "attributes": {
        "name": "<string>",
        "created_at": "2025-07-29T09:00:00Z",
        "updated_at": "2025-07-30T09:00:00Z"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization
string
required

The organization slug

server
integer
required

The server ID

Query Parameters

sort
string

Available sorts are name, created_at, updated_at. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -name.

include
string

Available includes are tags, tagsCount, tagsExists, latestDeployment, latestDeploymentCount, latestDeploymentExists. You can include multiple options by separating them with a comma.

page[size]
integer
default:30

The number of results that will be returned per page.

page[cursor]
string

The cursor to start the pagination from.

filter[name]
string

The name of the site.

Examples:

"forge.laravel.com"

Response

Paginated set of SiteResource

data
SiteResource · object[]
required
meta
object
required
included
(TagResource · object | DeploymentResource · object)[]
  • TagResource
  • DeploymentResource
I