WzState
Build your own websiteAPI referenceCompare

Hydrate a comparison shortlist from a list of ids

GET
/api/public/compare

Query Parameters

ids*unknown

Comma-separated ids (max 10)

type*string

Value in

  • "project"
  • "property"

Header Parameters

X-Site*string

The site key identifying which website this request belongs to. May be omitted only when the request comes from a domain already verified for the site (the Origin/Host then resolves it), or when the deprecated X-Subdomain header is used.

X-Api-Key?string

Publishable (pk_…) or secret (sk_…) key for this site. Required on writes; accepted on reads. NOTE: currently rolling out in monitor mode — a write without a valid key is logged rather than refused, so this is documented as optional. It becomes required on writes when enforcement is switched on; send it now.

Response Body

curl -X GET "https://example.com/api/public/compare?type=project" \  -H "X-Site: string"
Empty