---
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.
  - `entries` object[], required — A list of guides.
    - `__typename` string — The typename of the schema.
    - `activation_url_patterns` object[] — A list of URL Patterns to evaluate user's current location to activate the guide, if matched
      - `directive` string — The directive for the URL pattern ('allow' or 'block')
      - `pathname` string — The pathname pattern to match (supports wildcards like /*)
      - `search` string — The search query params to match
    - `activation_url_rules` object[] — A list of URL rules to evaluate user's current location to activate the guide, if matched
      - `argument` string — The value to compare against
      - `directive` string — The directive for the URL rule ('allow' or 'block')
      - `operator` string — The comparison operator ('contains' or 'equal_to')
      - `variable` string — The variable to evaluate ('pathname')
    - `active` boolean — Whether the guide is active.
    - `bypass_global_group_limit` boolean
    - `channel_id` string, uuid
    - `dashboard_url` string — URL to this guide in the Knock dashboard
    - `id` string, uuid — The unique identifier for the guide.
    - `inserted_at` string, date-time
    - `key` string — The key of the guide.
    - `semver` string
    - `steps` object[]
      - `content` object
      - `message` object
        - `archived_at` string, date-time, nullable
        - `id` string, nullable
        - `interacted_at` string, date-time, nullable
        - `link_clicked_at` string, date-time, nullable
        - `read_at` string, date-time, nullable
        - `seen_at` string, date-time, nullable
      - `ref` string
      - `schema_key` string
      - `schema_semver` string
      - `schema_variant_key` string
    - `type` string — The type of the guide.
    - `updated_at` string, date-time
  - `guide_group_display_logs` object, required — A map of guide group keys to their last display timestamps.
  - `guide_groups` object[], required — A list of guide groups with their display sequences and intervals.
    - `__typename` string
    - `display_interval` integer
    - `display_sequence` string[]
    - `inserted_at` string, date-time
    - `key` string
    - `updated_at` string, date-time
  - `ineligible_guides` object[], required — Markers for guides the user is not eligible to see.
    - `key` string, required — The guide's key identifier
    - `message` string, required — Human-readable explanation of ineligibility
    - `reason` 'guide_not_active' | 'marked_as_archived' | 'target_conditions_not_met' | 'not_in_target_audience', required — Reason code for ineligibility

---

[API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/revisions/4b8499dddbc5/schema)