List Sites
list_sitesRetrieve every site in an organization across all servers with domain, PHP version, repository, and deployment state. Include server data or filter by name to find one site in one call.
Instructions
List every site in an organisation across all servers, with its domain, project type, PHP version, repository, deployment and maintenance-mode state. Prefer this over listing sites server by server. Note that the hosting server is NOT included by default — pass include="server" to answer "which server hosts acme.com?" in one call. To find one site, filter by name (filter: {"name": "acme.com"}) rather than paging through them all. Sites on a revoked (archived) server are still listed as installed; with include="server" they are marked server_revoked: true, so a stale namesake is not taken for the live site.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated fields to sort by; prefix with "-" to reverse (e.g. "-created_at"). | |
| cursor | No | Pagination cursor from a previous response's meta.next_cursor. | |
| filter | No | Field filters, e.g. {"name": "acme-web"}. Supported fields vary by endpoint. | |
| include | No | Comma-separated relationships to embed (e.g. "tags,latestDeployment"). | |
| page_size | No | Items per page, at most 30. Forge caps pages at 30 and silently returns 30 for anything larger, so read the "page" line and follow the cursor. | |
| organization | No | Organisation slug. Optional when the server has a default configured. |