---
title: "List or search guides"
method: GET
path: "/guides"
tags: ["Guides"]
---

# List or search guides

`GET /guides`

## Request

- Base URL: `https://www.glitter.io/api/v1`
- URL: `https://www.glitter.io/api/v1/guides`
- Auth: HTTP bearer

Every guide the key reaches, drafts included, newest first. Narrow to a team with team_id, search titles with q, and page with limit and cursor.

## Query parameters

- `team_id` string, uuid
- `q` string
- `limit` integer
- `cursor` string

## Response `200`

Successful response

- GuidesPage
  - `data` object[], required: Pass as `cursor` to fetch the next page; null on the last page.
    - `team_id` string, nullable
    - `created_at` string, nullable
    - `id` string
    - `title` string, nullable
    - `description` string, nullable
    - `owner_name` string, nullable
    - `icon_url` string, nullable
    - `permalink` string, nullable
    - `publish_status` 'DRAFT' | 'PUBLISHED', nullable
    - `updated_at` string, nullable
    - `locked` boolean, required: Past the plan's guide limit: the guide opens as a short cut, in the app and through the API alike.
  - `next_cursor` string, nullable, required: Pass as `cursor` to fetch the next page; null on the last page.

## Other responses

- `400`: Invalid request
- `401`: Invalid or expired key
- `403`: Scope missing or API turned off
- `429`: Rate limited
- `500`: Internal error

---

[API](https://skmtc.dev/glitter/apis/glitter-ai-api.md) - [All operations](https://skmtc.dev/glitter/apis/glitter-ai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/glitter/apis/glitter-ai-api/revisions/9e385376d80e?raw)