---
title: "Provides the browse CBL Repo interface. Requires Download role."
method: GET
path: "/api/Cbl/browse"
tags: ["Cbl"]
---

# Provides the browse CBL Repo interface. Requires Download role.

`GET /api/Cbl/browse`

## Request

- Base URL: `http://localhost:5000`
- URL: `http://localhost:5000/api/Cbl/browse`
- Auth: API key in header `x-api-key`

## Query parameters

- `path` string

## Response `200`

OK

- CblRepoBrowseResultDto
  - `items` CblRepoItemDto[], nullable
    - `name` string, nullable
    - `path` string, nullable
    - `isDirectory` boolean
    - `sha` string, nullable
    - `size` integer
    - `downloadUrl` string, nullable
    - `existingReadingListId` integer, nullable
    - `alreadySynced` boolean
  - `rateLimit` GithubRateLimitDto
    - `remaining` integer, nullable
    - `limit` integer, nullable
    - `resetsAtUtc` string, date-time, nullable
    - `isLow` boolean
    - `isExhausted` boolean
  - `fromCache` boolean

## Changes

- **2026-10-28** `617fbc01bef6`: 3 warning, 3 info
  - removed the optional property `rateLimitDto` from the response with the `200` status (media type: text/plain)
  - removed the optional property `rateLimitDto` from the response with the `200` status (media type: application/json)
  - removed the optional property `rateLimitDto` from the response with the `200` status (media type: text/json)
  - added the optional property `rateLimit` to the response with the `200` status (media type: text/plain)
  - …2 more
- **2026-03-22** `777fe1636b50`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kareadita/apis/kavita/changes/api/Cbl/browse/get.md)

---

[API](https://skmtc.dev/kareadita/apis/kavita.md) - [All operations](https://skmtc.dev/kareadita/apis/kavita/llms.txt) - [OpenAPI document](https://skmtc.dev/kareadita/apis/kavita/revisions/d266465eeb67?raw)