---
title: "List sites"
method: GET
path: "/v1/sites"
tags: ["Sites"]
---

# List sites

`GET /v1/sites`

Get list of all sites and their details for given user, can be filtered by domain.

## Query parameters

- `domain` string — search string to match the domain by
- `search` string — Search for a site by its domain, label, or ID
- `page` integer — Page of results to include (default = 1)
- `per_page` integer — How many results to include in each page (default = 10)
- `sort` 'created_at' | 'domain' | 'label' | 'disk_usage'
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListSitesResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — Given site not found for user
- `405` — Invalid input
- `500` — Internal error

---

[API](https://skmtc.net/rocket/apis/rocket-net-api.md) · [All operations](https://skmtc.net/rocket/apis/rocket-net-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocket/rocket-net-api/versions/db0dcbbc5764/schema)