Skip to main content
GET
List websites

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Query Parameters

organizationId
string
Minimum string length: 1
cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100
sort
enum<string>
Available options:
createdAt,
updatedAt,
name
Maximum string length: 200
scope
enum<string>
Available options:
shared,
all
status
enum<string>

Which websites to list. Defaults to active. deleted returns the organization’s restorable soft-deleted websites (requires organizationId and organization-level trash access) with their deletion time and purge deadline.

Available options:
active,
deleted

Response

A page of websites: active rows with hostname and sharing info, or soft-deleted rows with trash timing when status=deleted.

items
object[]
required
nextCursor
string | null
required

Opaque cursor for the next page. Pass it as the cursor parameter on the next request. null when this is the last page.