> ## Documentation Index
> Fetch the complete documentation index at: https://docs.betterumami.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Website by ID — GET /api/websites/{websiteId}

> Fetch the full configuration and metadata for one website using its unique ID, including domain, sharing settings, team, and recording config.

Use this endpoint to retrieve the complete details and configuration for a single website. You need the `websiteId` — a UUID you can obtain from the [List Websites](https://docs.betterumami.com/api-reference/list-websites.md) endpoint or from the Betterumami dashboard. The response includes sharing settings, team assignment, recording configuration, and timestamps.

`GET /api/websites/{websiteId}`

## Request

### Headers

**Authorization** `string` *required*

Bearer token. Pass your API key: `Authorization: Bearer <api-key>`

### Path Parameters

**websiteId** `string` *required*

The unique UUID of the website to retrieve.

## Response

**200 – Success**

Returns the website object, or `null` if no website with that ID exists within your scope.

**id** `string` *required*

Unique UUID of the website.

**name** `string` *required*

Human-readable display name of the website.

**domain** `string | null` *required*

Domain tracked by this website, e.g. `example.com`.

**shareId** `string | null` *required*

Token used to access the public share page. `null` if sharing is disabled.

**teamId** `string | null` *required*

UUID of the team this website belongs to. `null` for personal websites.

**userId** `string | null` *required*

UUID of the user who created the website.

**createdBy** `string | null` *required*

UUID of the user who created the resource (same as `userId` in most cases).

**recorderEnabled** `boolean` *required*

Whether session recording and heatmap capture is active for this website.

**replayConfig** `object` *required*

Session replay and heatmap recording configuration.

**replayConfig.replayEnabled** `boolean`

Whether session replay recording is turned on.

**replayConfig.heatmapEnabled** `boolean`

Whether heatmap data capture is turned on.

**replayConfig.sampleRate** `number`

Fraction of sessions to record, from `0` (none) to `1` (all).

**replayConfig.heatmapSampleRate** `number`

Fraction of sessions from which heatmap data is captured.

**replayConfig.maskLevel** `string`

Privacy masking level applied during recording. One of `strict`, `moderate`, or `none`.

**replayConfig.blockSelector** `string`

CSS selector for DOM elements to block from recording.

**replayConfig.maxDuration** `number`

Maximum session recording length in seconds.

**resetAt** `string | null` *required*

ISO 8601 timestamp of the last analytics data reset, or `null` if never reset.

**createdAt** `string | null` *required*

ISO 8601 timestamp when the website record was created.

**updatedAt** `string | null` *required*

ISO 8601 timestamp when the website record was last updated.

**deletedAt** `string | null` *required*

ISO 8601 timestamp when the website was deleted, or `null` if it is active.

**user** `object`

Embedded owner information.

**user.id** `string`

UUID of the owning user.

**user.username** `string`

Username of the owning user.

```json 200 Response theme={null}
{
  "id": "b8d3a1f0-1c2d-4e5f-8a9b-0c1d2e3f4a5b",
  "name": "My Marketing Site",
  "domain": "example.com",
  "shareId": null,
  "teamId": null,
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "recorderEnabled": true,
  "replayConfig": {
    "replayEnabled": true,
    "heatmapEnabled": false,
    "sampleRate": 0.1,
    "heatmapSampleRate": 0,
    "maskLevel": "strict",
    "blockSelector": ".sensitive-data",
    "maxDuration": 3600
  },
  "resetAt": null,
  "createdAt": "2024-03-01T10:00:00Z",
  "updatedAt": "2024-06-15T08:22:00Z",
  "deletedAt": null,
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "username": "alice"
  }
}
```

## Code Sample

```bash theme={null}
curl -X GET 'https://api.umami.is/v1/websites/b8d3a1f0-1c2d-4e5f-8a9b-0c1d2e3f4a5b' \
  -H 'Authorization: Bearer <api-key>'
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.