---
title: "List indexed websites"
method: GET
path: "/integrations/web_crawler/websites"
tags: ["Integrations"]
---

# List indexed websites

`GET /integrations/web_crawler/websites`

## Request

- Base URL: `https://api.hyperspell.com`
- URL: `https://api.hyperspell.com/integrations/web_crawler/websites`
- Auth: HTTP bearer

List saved website collections, independently of crawl-history retention.

## Query parameters

- `cursor` string, nullable
- `q` string
- `limit` integer

## Headers

- `X-As-User` string, nullable: Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

## Response `200`

Successful Response

- WebsiteList
  - `websites` WebsiteSummary[], required
    - `url` string, required
    - `favicon` string, nullable
    - `pages` integer, required
    - `indexed` integer, required
    - `processing` integer, required
    - `failed` integer, required
    - `schedule` WebsiteScheduleInfo
      - `url` string, required
      - `frequency` 'never' | 'daily' | 'weekly', nullable
      - `configured` boolean
      - `enabled` boolean
      - `cron` string, nullable
      - `timezone` string
      - `max_depth` integer
      - `limit` integer
      - `next_run` string, date-time, nullable
      - `schedule_missing` boolean
      - `share` 'personal' | 'shared'
  - `next_cursor` string, nullable

## Other responses

- `422`: Validation Error

## Changes

> 43 revisions in range; 2 not diffed.

- **2026-10-26** `9bafd1215a0f`: 1 info
  - added the optional property `websites/items/schedule` to the response with the `200` status
- **2026-10-22** `cdf64d80b832`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hyperspell/apis/hyperspell-api/changes/integrations/web_crawler/websites/get.md)

---

[API](https://skmtc.dev/hyperspell/apis/hyperspell-api.md) - [All operations](https://skmtc.dev/hyperspell/apis/hyperspell-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hyperspell/apis/hyperspell-api/revisions/9bafd1215a0f?raw)