Get site details
Fetch a single site (the physical or virtual location associated with a conversation, sometimes called an address) by ID. Scoped to the partner the API key belongs to. Requires the site:read scope. include=subscription expands the site’s active subscription (id, billing-provider id, status, phase, pausedUntil and the partner product it is sold under); it is null when the site has no subscription or every subscription on it is canceled.
Authorizations
Send the API key in the x-api-key header.
Path Parameters
Site id. Newer ids are ovaid-<uuid>; legacy sites may have bare (e.g. numeric) ids.
1"ovaid-22222222-2222-4222-8222-222222222222"
Query Parameters
Comma-separated list of related resources to expand in the response. Allowed values: clients, projects, subscription.
"clients,projects,subscription"
Response
Site details
essentials_plus, priority, security_only, proactive, signature Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here — call the custom-property list endpoint to resolve an id to its name and type. A property never given a value takes the default configured for it, and is left out rather than returned as null when there is no default either. A value stored before its property was changed — an option renamed or removed, the type switched — is returned as stored, so it may not match the type the property has today; an absent key is the only reliable sign that nothing is set.
Inactive, Non-Member, Warranty Essentials, CPP Essentials Plus, Essentials Plus, CPP Priority, Priority, CPP Proactive, Proactive, CPP Signature, Signature, Secure, OV - Internal, Legacy A site's current subscription. Pricing and billing-period dates are not part of this payload: the platform stores neither, they live in the billing provider only.