---
title: "GET /api/v1/github/repositories/docs-config"
method: GET
path: "/api/v1/github/repositories/docs-config"
---

# GET /api/v1/github/repositories/docs-config

`GET /api/v1/github/repositories/docs-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/github/repositories/docs-config`
- Auth: none declared

## Query parameters

- `repository` string, required: owner/repo
- `branch` string, required
- `basePath` string

## Headers

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

## Response `200`

The docs config at the base path.

- GithubDocsConfig
  - `fileName` string, nullable, required: The docs config found at the base path, such as docs.json.

## Other responses

- `400`: Bad request, or a folder that is not the sync root
- `403`: Two-way sync is not enabled or permission is missing
- `404`: Folder or repository 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)