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

# List Guides

`GET /v1/guides/`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/v1/guides/`
- Auth: none declared

## Query parameters

- `q` string, nullable
- `tags` string, nullable
- `creator_id` integer, nullable
- `sort_by` string, nullable
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- GuideOut[]
  - `id` integer, required
  - `title` string, required
  - `body` string, required
  - `creator_id` integer, required
  - `creator` AppSchemasProductUserBasic: Basic user info for product creator display.
    - `id` integer, required
    - `username` string, nullable
  - `tags` Tag[]
    - `name` string, required
    - `description` string, nullable
    - `id` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `partle_url` string, required
  - `referenced_product_ids` integer[], required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/rubenayla/apis/partle-api.md) · [All operations](https://skmtc.dev/rubenayla/apis/partle-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rubenayla/apis/partle-api/revisions/2e12d4d3c6dd?raw)