---
title: "Get one guide"
method: GET
path: "/guides/{guideId}"
tags: ["Guides"]
---

# Get one guide

`GET /guides/{guideId}`

## Request

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

By id or permalink: metadata with markdown_body, the same text Export to markdown produces, screenshots as image links. On a plan without full API access markdown_body is the same preview a file export gets, `locked` guides are cut to their public preview, and `notice` (also closing markdown_body) says so.

## Response `200`

Successful response

- GuideResponse
  - `data` object, required
    - `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
    - `language` string
    - `text_direction` 'rtl' | 'ltr'
    - `app_version` string, nullable
    - `thumbnail_url` string, nullable
    - `tags` string[], nullable
    - `folder_id` string, nullable
    - `is_public` boolean
    - `markdown_body` string, required: The guide as markdown, the same text Export to markdown produces; a preview closes with the notice.
    - `brand_color` string, nullable, required: The team's brand color, null for Glitter's default.
    - `locked` boolean, required: Past the plan's guide limit: markdown_body is the short cut the guide's public page shows.
    - `notice` string, nullable, required: Null when the plan includes full guides through the API; otherwise why the guide stops where it does.

## 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)