Skip to main content
GET
Get site details

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Path Parameters

id
string
required

Site id. Newer ids are ovaid-<uuid>; legacy sites may have bare (e.g. numeric) ids.

Minimum string length: 1
Example:

"ovaid-22222222-2222-4222-8222-222222222222"

Query Parameters

include
string

Comma-separated list of related resources to expand in the response. Allowed values: clients, projects, subscription.

Example:

"clients,projects,subscription"

Response

Site details

id
string
required
address1
string | null
required
address2
string | null
required
city
string | null
required
state
string | null
required
zip
string | null
required
platformSlaId
enum<string> | null
required
Available options:
essentials_plus,
priority,
security_only,
proactive,
signature
customProperties
object
required

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.

Example:
tosAccepted
string
serviceLevel
enum<string>
Available options:
Inactive,
Non-Member,
Warranty Essentials,
CPP Essentials Plus,
Essentials Plus,
CPP Priority,
Priority,
CPP Proactive,
Proactive,
CPP Signature,
Signature,
Secure,
OV - Internal,
Legacy
clientSegment
string
cppExpDate
string<date-time>
businessName
string
brandId
string
primaryClientId
string
primaryProjectId
string
createdAt
string<date-time>
updatedAt
string<date-time>
sla
number
isMonitored
boolean
accountManager
object
membershipRegistered
boolean
clients
object[]
projects
object[]
subscription
object | null

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.