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

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

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

## 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}/broken-links`
- 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`

Broken links found by the latest succeeded build.

- DocsBrokenLinks
  - `checkedAt` string, nullable, required: When the latest succeeded build checked links.
  - `links` object[], nullable, required
    - `documentId` string, required
    - `pageTitle` string, required
    - `pageRoute` string, required
    - `text` string, required
    - `href` string, required
    - `reason` 'missing_page' | 'missing_anchor' | 'unpublished_document', required
    - `occurrences` integer, 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/c00420511526?raw)