Websites

List websites

Lists accessible websites. By default returns active websites: use organizationId to scope one organization, scope=shared without it for direct grants outside your memberships, or scope=all with it to combine both; supports sort by createdAt, updatedAt, or name and case-insensitive search, and each item includes organizationSlug, primaryHostname, and whether it is shared. Pass status=deleted with organizationId (requires organization-level trash access) to list restorable soft-deleted websites instead, each with its deletion time and purge deadline; deleted rows drop out when their 30-day restore window expires. Both modes use cursor pagination (default 20 per page, maximum 100). Fetch one website with websites.get.

get/websites

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites
  • Auth: HTTP bearer

Query parameters

organizationIdstring
cursorstring
limitinteger
sort'createdAt' | 'updatedAt' | 'name'
searchstring
scope'shared' | 'all'
status'active' | 'deleted'

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.

Response

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

nextCursorstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.