---
title: "List virtual tours"
method: POST
path: "/api/list_virtual_tours"
tags: ["Virtual tours"]
---

# List virtual tours

`POST /api/list_virtual_tours`

## Request

- Base URL: `https://app.pedra.ai`
- URL: `https://app.pedra.ai/api/list_virtual_tours`
- Auth: none required

Returns the account's virtual tours, newest first (max 100), with summary fields only (no scenes, links or settings). Deleted tours are excluded. Free.

## Request body

- object
  - `apiKey` string, required: Account API key, sent in the request body. Get one at https://app.pedra.ai under Settings → API.
  - `propertyId` string: Only return this property's tour.

## Response `200`

The tours.

- object
  - `tours` VirtualTourSummary[]
    - `tourId` string
    - `propertyId` string
    - `name` string, nullable
    - `status` 'processing' | 'ready' | 'failed'
    - `tourUrl` string: Public tour page. Stable across edits.
    - `embedCode` string: Ready-to-paste <iframe> for the tour.
    - `appUrl` string, nullable: The property in the Pedra app.
    - `shareable` boolean: false on free-plan accounts: the tour builds, but its public link shows an upgrade page.
    - `shareableNote` string: Present when shareable is false.
    - `sceneCount` integer
    - `linkCount` integer
    - `coverImageUrl` string, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `progress` object: Present while status is processing.
      - `stage` 'queued' | 'importing' | 'naming' | 'linking'
      - `done` integer
      - `total` integer
    - `error` string: Present when status is failed.
    - `lastError` string: Present on a ready tour whose last add_virtual_tour_scenes failed.
    - `failedScenes` object[]
      - `index` integer
      - `imageUrl` string
      - `error` string

## Other responses

- `404`: Missing, invalid, or revoked API key, or a tour/property that isn't on this account.
- `405`: Wrong HTTP method — all endpoints accept POST (credits also accepts GET).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/pedra/apis/pedra-api.md) · [All operations](https://skmtc.dev/pedra/apis/pedra-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pedra/apis/pedra-api/revisions/87b2e76912c8?raw)