Sites

List sandbox partner sites

Returns deterministic sandbox partner-site summaries when the authenticated automation client has sites.read. External URL: /v1/sites. Current Next.js implementation path: /api/platform/v1/sites. This read-only route does not require Idempotency-Key; it never renders public pages, publishes sites, writes CRM records, performs scheduling side effects, configures custom domains, or exposes partner secrets. Live site reads remain unavailable until ownership, publication, and route-promotion gates pass.

get/sites

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/sites
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of sandbox site summaries to return.

cursorstring

Opaque pagination cursor from a previous response.

status'draft' | 'review_requested' | 'approved' | 'published' | 'paused' | 'takedown_pending' | 'retracted' | 'archived'

Filter by sandbox site publication status.

template_id'agency_microsite' | 'agent_landing_page' | 'service_provider_landing_page' | 'mortgage_partner_lead_page'

Filter by approved sandbox site template.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Sandbox partner-site summaries.

livemodefalse required
request_idstring required

Changes

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