---
title: "GET /api/v1/docs-sites/{spaceId}"
method: GET
path: "/api/v1/docs-sites/{spaceId}"
---

# GET /api/v1/docs-sites/{spaceId}

`GET /api/v1/docs-sites/{spaceId}`

## Request

- Base URL: `https://falconer.com` (the document declares no server; this is the origin it was published from)
- URL: `https://falconer.com/api/v1/docs-sites/{spaceId}`
- Auth: none declared

## Path parameters

- `spaceId` integer, required: Space id, from GET /spaces.

## Headers

- `x-organization-id` string: Required when using OAuth bearer tokens.

## Response `200`

The docs site with its latest build.

- DocsSite
  - `spaceId` integer, required
  - `folderId` integer, required: The Space root folder's ID, for /nav and /folders.
  - `name` string, nullable, required
  - `subdomain` string, required
  - `url` string, required: Canonical live URL.
  - `falconerSiteUrl` string, required
  - `customDomain` string, nullable, required
  - `customDomainStatus` string, required
  - `isPublished` boolean, required
  - `isPasswordProtected` boolean, required
  - `publishedBuildId` string, nullable, required
  - `edgeOutcome` 'propagating' | 'confirmed' | 'unconfirmed' | 'failed', nullable, required
  - `canManage` boolean, required: Whether you can publish, roll back, or unpublish.
  - `latestBuild` DocsBuildSummary, nullable, required
    - `id` string, required
    - `buildNumber` integer, nullable, required
    - `status` 'queued' | 'building' | 'succeeded' | 'failed', required
    - `indexStatus` 'pending' | 'indexing' | 'ready' | 'failed', required: Search indexing of the build; meaningful once status is succeeded.
    - `error` string, nullable, required
    - `indexError` string, nullable, required
    - `autoPublish` boolean, required
    - `isPublished` boolean, required: Whether this build is the one the live site serves.
    - `staleSubdomain` boolean, required: Built before the site was renamed, so its canonical URLs and sitemap point at the old host. Publishing it serves stale URLs until a rebuild.
    - `requestedBy` object, nullable, required
      - `id` string, required
      - `name` string, nullable, required
    - `createdAt` string, required
    - `completedAt` string, nullable, required

## Other responses

- `400`: Bad request
- `403`: Public docs are not enabled or permission is missing
- `404`: Docs site or build not found

---

[API](https://skmtc.dev/falconer/apis/falconer-public-api.md) · [All operations](https://skmtc.dev/falconer/apis/falconer-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/falconer/apis/falconer-public-api/revisions/7b303b7ddf6a?raw)