---
title: "List your sites"
url: https://docs.corefinity.com/api/reference/sites/list-sites
type: endpoint
last_updated: 2026-11-13
feature: sites
related:
  - https://docs.corefinity.com/guides/sites/create-and-manage/site-overview.md
---
# List your sites

Every site you can open, one entry per site with its environments, in id order.
Paged by cursor: send `next_cursor` back as `cursor`; null means the last page.

```http
GET /api/corestack/sites
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: on

## Query parameters

- `cluster_id` (integer): Only the sites of this CoreCluster. A CoreCluster that is not yours answers `404`.
- `platform` (string): Only sites of this platform. Only the platforms available to your company are accepted.
- `kind` (string): `corecluster` for sites in one of your CoreClusters, `corestack` for standalone CoreStack sites.
- `search` (string): Part of a domain or of an environment name.
- `app_status` (string): `security` for sites on an application version that receives security fixes only, `eol` for sites on an ended version. Accepted only while application versions are on for your company; otherwise it is refused `422` on `app_status`.
- `limit` (integer): Items a page: 1 to 100, default 50.
- `cursor` (string): The `next_cursor` of the previous answer. One with other characters, or longer than 64, is refused `422` on `cursor`; any other value that is not a cursor reads the first page.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/sites",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 One page of sites.

```json
{
  "next_cursor": null,
  "sites": [
    {
      "cluster": {
        "id": 1017,
        "name": "Northwind UK 1"
      },
      "compute_family": "general",
      "covers_site": true,
      "domain": "harbourandfinch.example.com",
      "environment": {
        "env_id": "rs-northwind-harbourandfinch-example-com",
        "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
        "id": 1042,
        "name": "Production",
        "role": "production",
        "role_label": "Production",
        "slug": "production"
      },
      "environment_count": 1,
      "environments": [
        {
          "env_id": "rs-northwind-harbourandfinch-example-com",
          "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
          "id": 1042,
          "name": "Production",
          "role": "production",
          "role_label": "Production",
          "slug": "production"
        },
        {
          "env_id": "rs-northwind-harbourandfinch-example-com--staging",
          "hostname": "staging-harbourandfinch-example-com.northwind.cfstack.example.net",
          "id": 1043,
          "name": "Staging",
          "role": "staging",
          "role_label": "Staging",
          "slug": "staging"
        }
      ],
      "health": "healthy",
      "hosting": {
        "cluster_kind": "customer",
        "label": "CoreCluster Northwind UK 1"
      },
      "id": 1042,
      "kind": "corecluster",
      "limits": {
        "cpu_millicores": 2000,
        "disk_bytes": 10737418240,
        "memory_bytes": 4294967296
      },
      "logs": null,
      "mariadb": {
        "version": "11.8"
      },
      "mode": "production",
      "mode_label": "Domain attached",
      "operation": null,
      "package": null,
      "pending_changes": {
        "count": 0,
        "outcome_at": null,
        "state": null,
        "window_starts_at": null
      },
      "php": {
        "version": "8.3"
      },
      "platform": {
        "key": "wordpress",
        "label": "WordPress"
      },
      "platform_url": "https://harbourandfinch-example-com.northwind.cfstack.example.net",
      "primary_url": "https://harbourandfinch.example.com",
      "removed": false,
      "restore": null,
      "site": {
        "domain": "harbourandfinch.example.com",
        "id": 1042
      },
      "site_id": "rs-northwind-harbourandfinch-example-com",
      "snapshots": {
        "count": 0,
        "effective_frequency": "off",
        "effective_label": "Off",
        "latest": null,
        "latest_ready_at": null,
        "next_scheduled_at": null,
        "overridden": false,
        "stored_gb": 0
      },
      "tier": "S",
      "uat_size": null,
      "usage": {
        "cpu_millicores": 180,
        "disk_used_bytes": 2147483648,
        "memory_bytes": 912261120,
        "observed_at": "2026-11-14T09:10:00Z",
        "source": "live"
      }
    }
  ]
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), or your company requires two-factor authentication and you have not set it up. For routes outside Managed Clusters.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The CoreCluster named by `cluster_id` does not exist or is not yours to see.

```json
{
  "message": "Not found."
}
```

### 422 A filter value is not allowed.

```json
{
  "code": "invalid",
  "errors": {
    "limit": [
      "The limit may not be greater than 100."
    ]
  },
  "field": "limit",
  "message": "The limit may not be greater than 100.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 |  | Check the id. You see only what your account can reach. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Site overview](https://docs.corefinity.com/guides/sites/create-and-manage/site-overview.md)
