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

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

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

## 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}/config`
- 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 site settings.

- DocsSiteConfig
  - `config` ResolvedDocsSiteConfig, required
    - `name` string, required
    - `favicon` string
    - `logo` object
      - `light` string
      - `dark` string
      - `href` string, uri
    - `colors` object
      - `primary` string
      - `primaryDark` string
    - `navbar` object
      - `links` object[]
        - `label` string, required
        - `href` string, uri, required
      - `primary` object
        - `label` string
        - `href` string, uri
    - `contextual` object
      - `options` string[]
    - `seo` object, required
      - `description` string
      - `indexable` boolean, required
      - `metatags` object[]
        - `name` string, required
        - `content` string, required
    - `social` object[], required
      - `icon` 'github' | 'gitlab' | 'bitbucket' | 'codeberg' | 'stackoverflow' | 'discord' | 'slack' | 'matrix' | 'telegram' | 'whatsapp' | 'signal' | 'mastodon' | 'bluesky' | 'threads' | 'twitter' | 'x.com' | 'linkedin' | 'facebook' | 'instagram' | 'tiktok' | 'pinterest' | 'reddit' | 'youtube' | 'twitch' | 'patreon' | 'discourse' | 'zulip' | 'rss' | 'email' | 'phone', required
      - `href` string, uri, required
    - `analytics` object[]
      - `name` string, required
      - `snippet` string, required
    - `footer` object
      - `links` object[]
        - `header` string
        - `items` object[]
          - `label` string, required
          - `href` string, required
  - `hasUnpublishedChanges` boolean, required: Whether the settings differ from the live build.
  - `whiteLabel` boolean, 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)