Sign in
Guides
Users

List guides

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

get/v1/users/{user_id}/guides/{channel_id}

Path parameters

user_idstring required

The ID for the user that you set when identifying them in Knock.

channel_idstring uuid required

The unique identifier for the channel.

Query parameters

tenantstring

The tenant ID to use for targeting and rendering guides.

datastring

The data (JSON encoded object) to use for targeting and rendering guides.

typestring

The type of guides to filter by.

Response

OK

Example response

{
  "guides": [
    {
      "content": "New prehistoric specimens added to the visitor center display.",
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "title": "Amber Collection Updated"
    },
    {
      "content": "Version 2.1 - Enhanced paddock monitoring now available.",
      "id": "fe6c2c9c-849e-48d2-a5e5-9dc1f6b0f806",
      "title": "Security Systems Upgraded"
    }
  ],
  "recipient": {
    "id": "dr_malcolm"
  }
}

Changes