Sign in
Feeds
Users

List feed items

Returns a paginated list of feed items for a user, including metadata about the feed.

get/v1/users/{user_id}/feeds/{id}

Path parameters

user_idstring required

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

idstring uuid required

The unique identifier for the channel.

Query parameters

status'unread' | 'read' | 'unseen' | 'seen' | 'all'

The status of the feed items.

sourcestring

The source of the feed items.

tenantstring

The tenant associated with the feed items.

has_tenantboolean

Whether the feed items have a tenant.

workflow_categories[]string[]

The workflow categories of the feed items.

archived'exclude' | 'include' | 'only'

The archived status of the feed items.

trigger_datastring

The trigger data of the feed items (as a JSON string).

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page.

Response

OK

varsobject required

Additional variables for the feed item.

Example response

{
  "entries": [
    {
      "__typename": "FeedItem",
      "activities": [
        {
          "__typename": "Activity",
          "actor": null,
          "data": {
            "foo": "bar"
          },
          "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
          "inserted_at": "2024-01-01T00:00:00Z",
          "recipient": {
            "__typename": "User",
            "avatar": null,
            "created_at": null,
            "email": "jane@ingen.net",
            "id": "jane",
            "name": "Jane Doe",
            "phone_number": null,
            "timezone": null,
            "updated_at": "2024-05-22T12:00:00Z"
          },
          "updated_at": "2024-01-01T00:00:00Z"
        }
      ],
      "actors": [
        {
          "__typename": "User",
          "avatar": null,
          "created_at": null,
          "email": "jane@ingen.net",
          "id": "jane",
          "name": "Jane Doe",
          "phone_number": null,
          "timezone": null,
          "updated_at": "2024-05-22T12:00:00Z"
        }
      ],
      "blocks": [
        {
          "content": "This is a message in an app feed",
          "name": "body",
          "rendered": "<p>This is a message in an app feed</p>",
          "type": "markdown"
        }
      ],
      "data": {
        "foo": "bar"
      },
      "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
      "inserted_at": "2021-01-01T00:00:00Z",
      "source": {
        "__typename": "Workflow",
        "categories": [
          "collaboration"
        ],
        "key": "my_source",
        "version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "tenant": "acme_corp",
      "total_activities": 10,
      "total_actors": 5,
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "__typename": "FeedMetadata",
    "total_count": 100,
    "unread_count": 10,
    "unseen_count": 5
  },
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  },
  "vars": {
    "foo": "bar"
  }
}

Changes