# Get a site

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

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

The site: its draft design, a digest of every page and section with its id, problems, status and a preview link of the draft on its real address.

### Path parameters

- `id` (string, required): The site id.

### Query parameters

- `videos` (boolean, optional): `true` also lists the videos the site may show: the account's interactive exports whose choices are published and shared.
- `images` (boolean, optional): `true` also lists library pictures for a logo or an about section.

## Response

Returns `200`.

### Response fields

- `site` (object): `id`, `prefix`, `url`, `status`, `rev`, `shown`, `notShownBecause`, `takenDown`, `previewUrl`, `design`, `digest`, `problems`, `unpublishedChanges`, and `videos` / `images` when asked.

## Errors

Besides the errors any request can get ([authentication](https://developer.vidmoat.com/developer/docs/authentication#when-a-request-is-refused), [rate limits](https://developer.vidmoat.com/developer/docs/rate-limits)):

| Status | Code | When |
| --- | --- | --- |
| 404 | [`not_found`](https://developer.vidmoat.com/developer/docs/errors#not_found) | No such project, or it is not yours. The two are indistinguishable on purpose. |

## Request examples

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

```js Node
const SITE_ID = 'REPLACE_ME';

const res = await fetch(`https://api.vidmoat.com/v1/interactive-sites/${SITE_ID}?videos=true`, {
  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

SITE_ID = "REPLACE_ME"

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

## Example response

```json
{
  "site": {
    "id": "clxsite0001",
    "prefix": "river-films",
    "url": "https://river-films.interactive.vidmoat.com",
    "status": "draft",
    "rev": 0,
    "shown": false,
    "previewUrl": "https://river-films.interactive.vidmoat.com/?preview=1763125200000.5f2c",
    "problems": []
  }
}
```

---

Source: https://developer.vidmoat.com/developer/docs/api/interactive-sites/get-interactive-site
Previous: [Check a prefix](https://developer.vidmoat.com/developer/docs/api/interactive-sites/interactive-site-availability.md)
Next: [Edit a site](https://developer.vidmoat.com/developer/docs/api/interactive-sites/edit-interactive-site.md)
All documentation: https://developer.vidmoat.com/llms-full.txt
