List All Websites — Betterumami GET /api/websites

Retrieve a paginated list of websites you own or can access through team membership, with optional search, sorting, and result-limit controls.

Use this endpoint to fetch every website your API key can access. The response is paginated, so you can iterate over large sets with the page and pageSize parameters. Pass includeTeams to also return websites made available to you through team membership.

GET /api/websites

Request

Headers

Authorization · string · required

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

Query Parameters

page · integer

Page number to return, starting at 1. Defaults to 1.

pageSize · integer

Number of website records to return per page. Defaults to server-defined limit.

maxResults · integer

Hard cap on the total number of results included across all pages.

search · string

Filter websites by name or domain. The search is case-insensitive and matches partial strings.

orderBy · string

Field name to sort results by, e.g. name, domain, or createdAt.

sortDescending · string

Set to true to reverse the sort order. Accepted values: true, false.

includeTeams · string

When present with any non-empty value, websites accessible through teams you own or manage are included in the results.

Response

200 – Success

count · integer · required

Total number of website records matching the query.

data · Website[] · required

Array of website objects. Each object contains the fields below.

data[].id · string

Unique UUID of the website.

data[].name · string

Human-readable display name of the website.

data[].domain · string

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

data[].shareId · string | null

Token used to access the website’s public share page. null if sharing is disabled.

data[].teamId · string | null

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

data[].userId · string | null

UUID of the user who owns the website.

data[].createdBy · string | null

UUID of the user who created the website.

data[].recorderEnabled · boolean

Whether session recording is enabled for this website.

data[].replayConfig · object

Session replay and heatmap recording configuration for this website.

data[].resetAt · string | null

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

data[].createdAt · string | null

ISO 8601 timestamp when the website was created.

data[].updatedAt · string | null

ISO 8601 timestamp when the website was last updated.

data[].deletedAt · string | null

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

data[].user · object

Embedded owner information.

page · integer · required

The current page number returned.

pageSize · integer · required

Number of results per page for this response.

orderBy · string

Field used to sort the results.

search · string

The search string applied to this result set, if any.

200 Response

{
  "count": 2,
  "data": [
    {
      "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": false,
      "replayConfig": {
        "replayEnabled": false,
        "heatmapEnabled": false,
        "sampleRate": 0,
        "heatmapSampleRate": 0,
        "maskLevel": "strict",
        "blockSelector": "",
        "maxDuration": 0
      },
      "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"
      }
    },
    {
      "id": "c9e4b2f1-2d3e-5f6a-9b0c-1d2e3f4a5b6c",
      "name": "Docs Portal",
      "domain": "docs.example.com",
      "shareId": "shr_abc123",
      "teamId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "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": "",
        "maxDuration": 3600
      },
      "resetAt": null,
      "createdAt": "2024-05-10T14:30:00Z",
      "updatedAt": "2024-07-01T09:00:00Z",
      "deletedAt": null,
      "user": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "username": "alice"
      }
    }
  ],
  "page": 1,
  "pageSize": 20,
  "orderBy": "name",
  "search": ""
}

Code Sample

curl -X GET 'https://api.umami.is/v1/websites?page=1&pageSize=20&includeTeams=true' \
  -H 'Authorization: Bearer <api-key>'