---
title: "List space sites"
method: GET
path: "/space/{spaceId}/site/list"
tags: ["Space Site"]
---

# List space sites

`GET /space/{spaceId}/site/list`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/space/{spaceId}/site/list`
- Auth: HTTP bearer

## Path parameters

- `spaceId` string, required

## Query parameters

- `cursor` string: The cursor to use for pagination
- `order` 'asc' | 'desc': The order of the paginated items
- `take` integer: The number of items to retrieve
- `meta` object: Key-value pairs to filter the sites by metadata

## Response `200`

The list of sites was retrieved successfully

- object
  - `items` object[], required
    - `alias` string, nullable: The unique alias for the instance
    - `name` string: The associated name
    - `description` string: The associated description
    - `meta` Meta: Meta data information
    - `id` string, required: The instance ID
    - `createdAt` number, required: The timestamp (ms) when the instance was created
    - `updatedAt` number, required: The timestamp (ms) when the instance was updated
    - `slug` string: The subdomain slug of the site
    - `prefix` string: The folder prefix inside the space
    - `index` string: Directory index filename
    - `notFound` string: Not found filename
    - `access` 'public' | 'private': Who can open the site - public (anyone) or private (only through a temporary link)
  - `cursor` string, required: Cursor for fetching the next page

## Other responses

- `default`: An error response

---

[API](https://skmtc.dev/chatbotkit/apis/cbk-api.md) · [All operations](https://skmtc.dev/chatbotkit/apis/cbk-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatbotkit/apis/cbk-api/revisions/13d250576136?raw)