Skip to main content

​
1. Generate an API key

Sign in to sitevisit.app, open Settings → Developers, give the key a name (e.g. local-dev), and click Generate key.
The full key is shown exactly once. Copy it now and store it in your secret manager — we keep only a hash, so we can’t show it again. If you lose it, revoke it and generate a new one.
Keys look like: 
sv_live_e059b3544b7fa4b93c7e26933aeba781
The sv_live_ prefix identifies the environment; the random tail is hashed at rest.

​
2. Make your first call

List your properties: 
curl https://sitevisit.app/api/v1/properties \
  -H "Authorization: Bearer sv_live_..."
A successful response looks like: 
{
  "data": [
    {
      "id": "clx0...",
      "name": "Happy Apartments",
      "address": "123 Main St, Sample City",
      "icon_emoji": "🏢",
      "cover_image_url": "https://...",
      "is_sample": true,
      "visit_count": 2,
      "open_item_count": 3,
      "created_at": "2026-05-01T15:32:11.000Z",
      "updated_at": "2026-06-04T09:01:44.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

​
3. Drill into a visit

Grab a property id from the response above, then list its visits: 
curl "https://sitevisit.app/api/v1/site-visits?property_id=clx0..." \
  -H "Authorization: Bearer sv_live_..."
Then list the action items for that visit: 
curl "https://sitevisit.app/api/v1/action-items?site_visit_id=cly5..." \
  -H "Authorization: Bearer sv_live_..."
Each action item includes its priority, status, transcript quote, timestamp into the original video, and links to the evidence photos.

​
4. Page through results

Lists return up to 25 rows by default (100 max). To fetch the next page, pass the previous response’s next_cursor as starting_after: 
curl "https://sitevisit.app/api/v1/site-visits?starting_after=cly5...&limit=50" \
  -H "Authorization: Bearer sv_live_..."
When has_more is false, you’ve reached the end. Full details in Pagination.

​
What’s next

  • Browse the API reference for every parameter and field.
  • Read Errors to understand what each status code means.
  • If you’re building an AI agent or workflow, check out the MCP server — it wraps these same endpoints as natural-language tools.