---
title: "List guides"
method: GET
path: "/v1/users/{user_id}/guides/{channel_id}"
tags: ["Guides", "Users"]
---

# List guides

`GET /v1/users/{user_id}/guides/{channel_id}`

Returns a list of eligible in-app guides for a specific user and channel.

## Path parameters

- `user_id` string, required
- `channel_id` string, uuid, required

## Query parameters

- `tenant` string
- `data` string
- `type` string

## Response `200`

OK

- GuidesResponse — A response for a list of guides.
  - `guides` object[], required — A list of guides.
    - `content` string — The content of the guide.
    - `id` string, uuid — The unique identifier for the guide.
    - `metadata` object — The metadata of the guide.
    - `title` string — The title of the guide.
  - `recipient` object — The recipient of the guide.
    - `id` string — Unique identifier for the recipient.

## Changes

- **2025-05-10** `5176d1bb3a88` — 1 breaking, 1 info
  - added `subschema #1, subschema #2` to the `recipient` response property `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the `recipient` response property `oneOf` list for the response status `200`

[Change history](https://skmtc.dev/knocklabs/apis/knock-api/changes/v1/users/:user_id/guides/:channel_id/get.md)

---

[API](https://skmtc.dev/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.dev/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc.dev/knocklabs/apis/knock-api/revisions/5ce0d88003ac?raw)