---
title: "List website visits"
method: GET
path: "/website-visits"
tags: ["Website Visits"]
---

# List website visits

`GET /website-visits`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/website-visits`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/website-visits/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a paginated list of website visits.

## Query parameters

- `limit` integer
- `cursor` string
- `cols` string
- `contactId` string
- `organizationId` string

## Response `200`

OK

- WebsiteVisitList
  - `success` true, required
  - `data` ApiWebsiteVisit[], required
    - `id` string, required: Prefixed website visit cursor (format `w_<cursor>`)
    - `visitTime` string, date-time, required: When the visit occurred
    - `url` string, uri: The visited page URL
    - `contactId` string: Prefixed contact ID (format `c_<number>`)
    - `organizationId` string: Prefixed organization ID (format `o_<number>`)
  - `meta` object, required
    - `nextCursor` string, nullable: Cursor for pagination; pass as the `cursor` query parameter to fetch the next page.
    - `recordCount` integer: Total number of records matching the query. Only returned when `cols=recordCount` is requested.

## Other responses

- `400`: Bad Request — also returned for malformed filters, e.g. "Invalid lightFilter: must be valid JSON", "Invalid lightFilter: does not match LightFilterExpression schema", or an unknown filter field.
- `403`: Forbidden
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)