Skip to main content
GET
Fetch a property

Authorizations

Authorization
string
header
required

Bearer API key. Two modes: sv_live_* for production data, sv_test_* for a parallel sandbox dataset that doesn't count against plan limits. Issued from Settings → Developers in the SiteVisit app.

Path Parameters

id
string
required

Response

The requested resource.

id
string
required
name
string
required
isSample
boolean
required
isTest
boolean
required

True for objects created via a sv_test_* API key. Stripe-style test-mode flag — test data is never returned to live-mode callers and vice versa.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
visitCount
integer
required
openItemCount
integer
required
address
string | null
notes
string | null
iconEmoji
string | null
coverImageUrl
string | null