# List sites

`GET https://api.vidmoat.com/v1/interactive-sites`

- Scope: `projects.read`
- Cost: Free

The account's sites (one per account for now), the limit, and whether it may make one.

## Response

Returns `200`.

### Response fields

- `sites` (object[]): Each site: `id`, `prefix`, `url`, `status` (`draft`, `live`, `unpublished`, `offline`), `rev`, `shown`, `previewUrl`, `design`, `digest`, `problems`.
- `limit` (integer): Sites per account (1).
- `canCreate` (boolean): Whether this account may make one now.
- `reason` (string): When it may not: why.

## Request examples

```bash curl
curl https://api.vidmoat.com/v1/interactive-sites \
  -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const res = await fetch('https://api.vidmoat.com/v1/interactive-sites', {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

res = requests.get(
    "https://api.vidmoat.com/v1/interactive-sites",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

## Example response

```json
{
  "sites": [],
  "limit": 1,
  "domain": "interactive.vidmoat.com",
  "canCreate": true
}
```

---

Source: https://developer.vidmoat.com/developer/docs/api/interactive-sites/list-interactive-sites
Previous: [Preview a project](https://developer.vidmoat.com/developer/docs/api/renders/get-preview.md)
Next: [Make a site](https://developer.vidmoat.com/developer/docs/api/interactive-sites/create-interactive-site.md)
All documentation: https://developer.vidmoat.com/llms-full.txt
