---
title: "List references"
method: GET
path: "/api/reference"
tags: ["reference"]
---

# List references

`GET /api/reference`

## Request

- Base URL: `https://opencode.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://opencode.ai/api/reference`
- Auth: none required

List references available in the requested location.

## Query parameters

- `location` object, nullable
  - `directory` string, nullable

## Response `200`

Success

- object
  - `location` LocationPublicRef, required
    - `directory` string, required
  - `data` ReferenceInfo[], required
    - `name` string, required
    - `path` string, required
    - `description` string
    - `hidden` boolean
    - `source` union, required
      - ReferenceLocalSource
        - `type` 'local', required
        - `path` string, required
      - ReferenceGitSource
        - `type` 'git', required
        - `repository` string, required
        - `branch` string

## Other responses

- `400`: InvalidRequestError
- `401`: UnauthorizedError
- `404`: LocationNotFoundError

---

[API](https://skmtc.dev/kaaass/apis/opencode.md) - [All operations](https://skmtc.dev/kaaass/apis/opencode/llms.txt) - [OpenAPI document](https://skmtc.dev/kaaass/apis/opencode/revisions/4e083d954707?raw)