> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sitevisit.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List properties

> Returns the properties owned by the authenticated account.



## OpenAPI

````yaml /api-reference/openapi.json get /properties
openapi: 3.1.0
info:
  title: SiteVisit AI API
  version: 1.0.0
  description: >-
    Public REST API for SiteVisit AI. Read and write properties, site visits,
    and action items from your account. 


    ## Authentication


    Authenticate with a `Bearer sv_live_...` token issued in Settings →
    Developers. Two key modes are supported:


    - **Live keys (`sv_live_*`)** — operate on your real customer data. Counts
    against plan limits, fires real webhooks + PostHog activation events.

    - **Test keys (`sv_test_*`)** — operate on a parallel sandbox dataset (every
    resource is tagged `isTest=true`). Test data is free + unmetered, never
    counts against plan limits, and never crosses into live data. Use for
    development + integration testing without touching production.


    Test-mode webhook endpoints (configured with `mode=test` in the Settings UI)
    only receive events triggered by test keys; live endpoints only receive live
    events. Webhook payloads include a `livemode: bool` flag so receivers can
    branch without parsing the resource.
  contact:
    name: SiteVisit AI Support
    email: support@sitevisit.app
servers:
  - url: https://sitevisit.app/api/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /properties:
    get:
      summary: List properties
      description: Returns the properties owned by the authenticated account.
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/StartingAfter'
        - name: exclude_sample
          in: query
          description: Set to true to hide the Happy Apartments tutorial property.
          schema:
            type: boolean
      responses:
        '200':
          description: Paginated list of resources.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Property'
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
                required:
                  - data
                  - has_more
                  - next_cursor
        '400':
          description: Validation error (bad query param).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
    StartingAfter:
      name: starting_after
      in: query
      description: ID of the last seen item from the previous page.
      schema:
        type: string
  schemas:
    Property:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        address:
          type:
            - string
            - 'null'
        notes:
          type:
            - string
            - 'null'
        iconEmoji:
          type:
            - string
            - 'null'
        coverImageUrl:
          type:
            - string
            - 'null'
        isSample:
          type: boolean
        isTest:
          type: boolean
          description: >-
            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:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        visitCount:
          type: integer
        openItemCount:
          type: integer
      required:
        - id
        - name
        - isSample
        - isTest
        - createdAt
        - updatedAt
        - visitCount
        - openItemCount
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_api_key
            message:
              type: string
              example: The API key provided is invalid, revoked, or doesn't exist.
            docs_url:
              type: string
              format: uri
            request_id:
              type: string
              example: req_abc123
          required:
            - code
            - message
            - docs_url
            - request_id
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sv_live_xxx (or sv_test_xxx for sandbox mode)
      description: >-
        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.

````