---
title: "List snippets"
method: GET
path: "/v1/snippets"
tags: ["snippets"]
---

# List snippets

`GET /v1/snippets`

## Request

- Base URL: `https://api.botdog.co`
- URL: `https://api.botdog.co/v1/snippets`
- Auth: API key in header `x-api-key`

List message snippets/templates visible to the caller (personal + team-shared).

## Query parameters

- `status` 'ACTIVE' | 'ARCHIVED'
- `limit` number
- `cursor` string

## Response `200`

- PaginatedSnippetsDto
  - `data` SnippetDto[], required
    - `id` string, required: The unique identifier of the snippet
    - `name` string, required: The name of the snippet
    - `shortcut` string, nullable: The keyboard shortcut for the snippet, if any
    - `type` string, required: The snippet type: a static TEXT template or an LLM prompt
    - `status` string, required: The snippet status
    - `content` string, nullable: The template body (for TEXT snippets)
    - `prompt` string, nullable: The generation prompt (for LLM snippets)
    - `isShared` boolean, required: Whether the snippet is shared with the team
    - `createdAt` string, date-time, required: When the snippet was created
    - `updatedAt` string, date-time, required: When the snippet was last updated
  - `nextCursor` string, nullable, required: Opaque cursor for the next page; null when there are no more results. Pass it back as the `cursor` query parameter.

## Other responses

- `401`: Unauthorized. API key is missing or invalid.
- `403`: The key owner has no seat assigned (write endpoints only), the team is on Botdog Managed and so may only read (write endpoints only), or the subscription/plan does not permit this.
- `429`: Rate limit exceeded. Retry after cooldown.

---

[API](https://skmtc.dev/botdog/apis/botdog-api.md) · [All operations](https://skmtc.dev/botdog/apis/botdog-api/llms.txt) · [OpenAPI document](https://skmtc.dev/botdog/apis/botdog-api/revisions/6c0213d8a608?raw)