API ReferenceGET /v1/sites

GET /v1/sites

List all sites belonging to your account, most recently created first.

Cost: Free.

Request

curl https://api.warpweb.ai/v1/sites \
  -H "Authorization: Bearer wpwb_sk_xxx"

Query parameters

ParameterTypeDefaultDescription
limitinteger50Page size. Max 200.
cursorstringOpaque pagination cursor from a previous response’s next_cursor.
statusstringFilter by status: building, deploying, live, paused, failed.
hosting_tierstringFilter by tier: free_subdomain or paid_custom_domain.

Response

{
  "sites": [
    {
      "site_id": "site_8f3c2a1b-5d47-4c9e-b820-1f8a3e7d9c4f",
      "status": "live",
      "deployed_url": "https://brookside-plumbing.warpweb.app",
      "business_name": "Brookside Plumbing",
      "hosting_tier": "free_subdomain",
      "last_refreshed_at": "2026-05-15T09:12:44Z",
      "created_at": "2026-05-14T18:02:11Z"
    },
    {
      "site_id": "site_4d8b1c7a-9e23-4f5a-b612-7c4a9f3e8d2b",
      "status": "live",
      "deployed_url": "https://acme-roofing.com",
      "business_name": "Acme Roofing",
      "hosting_tier": "paid_custom_domain",
      "created_at": "2026-05-10T11:34:02Z"
    }
  ],
  "next_cursor": null
}
FieldDescription
sitesArray of site summaries. Use GET /v1/sites/:id for full detail.
next_cursorIf present, pass as cursor on the next request to fetch the next page. null when there are no more results.

Each site summary includes site_id, status, deployed_url, business_name, hosting_tier, created_at, and (for free-tier sites) last_refreshed_at.

Errors

StatusErrorCause
400invalid_cursorCursor is malformed or expired. Start a fresh query.
400invalid_filterstatus or hosting_tier value not in the allowed set.