--- title: "List feed items" method: GET path: "/v1/users/{user_id}/feeds/{id}" tags: ["Feeds", "Users"] --- # List feed items `GET /v1/users/{user_id}/feeds/{id}` Returns a paginated list of feed items for a user in reverse chronological order, including metadata about the feed. If the user has not yet been identified within Knock, an empty feed will be returned. You can customize the response using [response filters](/integrations/in-app/knock#customizing-api-response-content) to exclude or only include specific properties on your resources. **Notes:** * When making this call from a client-side environment, use your publishable key along with a user token. * This endpoint’s rate limit is always scoped per-user and per-environment. This is true even for requests made without a signed user token. * Any [attachments](/integrations/email/attachments) present in trigger data are automatically excluded from both the `data` and `activities` fields of `UserInAppFeedResponse`. ## Path parameters - `user_id` string, required - `id` string, uuid, required ## Query parameters - `status` 'unread' | 'read' | 'unseen' | 'seen' | 'all' - `source` string - `tenant` string - `has_tenant` boolean - `workflow_categories[]` string[] - `archived` 'exclude' | 'include' | 'only' - `trigger_data` string - `locale` string - `exclude` string - `mode` 'compact' | 'rich' - `after` string - `before` string - `page_size` integer - `inserted_at.gt` string - `inserted_at.gte` string - `inserted_at.lt` string - `inserted_at.lte` string ## Response `200` OK - UserInAppFeedResponse — A paginated list of feed items. - `entries` InAppFeedItem[], required — The list of feed items in the user's feed. - `__typename` string, required — The typename of the schema. - `activities` Activity[], required — List of activities associated with this feed item. - `__typename` string — The typename of the schema. - `actor` union — The actor who performed the activity. - union — A recipient of a notification, which is either a user or an object. - object — A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier. - `__typename` string, required — The typename of the schema. - `avatar` string, nullable — A URL for the avatar of the user. - `created_at` string, date-time, nullable — The creation date of the user from your system. - `email` string, nullable — The primary email address for the user. - `id` string, required — The unique identifier of the user. - `name` string, nullable — Display name of the user. - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels). - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients). - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - object — A custom [Object](/concepts/objects) entity which belongs to a collection. - `__typename` string, required — The typename of the schema. - `collection` string, required — The collection this object belongs to. - `created_at` string, date-time, nullable — Timestamp when the resource was created. - `id` string, required — Unique identifier for the object. - `properties` object — The custom properties associated with the object. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - object, nullable - `data` object, nullable — The workflow trigger `data` payload associated with the activity. - `id` string — Unique identifier for the activity. - `inserted_at` string, date-time — Timestamp when the activity was created. - `recipient` union — A recipient of a notification, which is either a user or an object. - object — A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier. - `__typename` string, required — The typename of the schema. - `avatar` string, nullable — A URL for the avatar of the user. - `created_at` string, date-time, nullable — The creation date of the user from your system. - `email` string, nullable — The primary email address for the user. - `id` string, required — The unique identifier of the user. - `name` string, nullable — Display name of the user. - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels). - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients). - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - object — A custom [Object](/concepts/objects) entity which belongs to a collection. - `__typename` string, required — The typename of the schema. - `collection` string, required — The collection this object belongs to. - `created_at` string, date-time, nullable — Timestamp when the resource was created. - `id` string, required — Unique identifier for the object. - `properties` object — The custom properties associated with the object. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - `updated_at` string, date-time — Timestamp when the activity was last updated. - `actors` Recipient[], required — List of actors associated with this feed item. - union — A recipient of a notification, which is either a user or an object. - object — A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier. - `__typename` string, required — The typename of the schema. - `avatar` string, nullable — A URL for the avatar of the user. - `created_at` string, date-time, nullable — The creation date of the user from your system. - `email` string, nullable — The primary email address for the user. - `id` string, required — The unique identifier of the user. - `name` string, nullable — Display name of the user. - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels). - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients). - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - object — A custom [Object](/concepts/objects) entity which belongs to a collection. - `__typename` string, required — The typename of the schema. - `collection` string, required — The collection this object belongs to. - `created_at` string, date-time, nullable — Timestamp when the resource was created. - `id` string, required — Unique identifier for the object. - `properties` object — The custom properties associated with the object. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - `archived_at` string, nullable — Timestamp when the feed item was archived. - `blocks` union[], required — Content blocks that make up the feed item. - union — A content block for the feed, can be content or a button set. - object — A block in a message in an app feed. - `content` string, required — The content of the block in a message in an app feed. - `name` string, required — The name of the block in a message in an app feed. - `rendered` string, required — The rendered HTML version of the content. - `type` 'markdown' | 'text', required — The type of block in a message in an app feed. - object — A button set block in a message in an app feed. - `buttons` object[], required — A list of buttons in an in app feed message. - `action` string, required — The action to take when the button is clicked. - `label` string, required — The label of the button. - `name` string, required — The name of the button. - `name` string, required — The name of the button set in a message in an app feed. - `type` 'button_set', required — The type of block in a message in an app feed. - `clicked_at` string, nullable — Timestamp when the feed item was clicked. - `data` object, nullable, required — Additional data associated with the feed item. - `id` string, required — Unique identifier for the feed. - `inserted_at` string, required — Timestamp when the resource was created. - `interacted_at` string, nullable — Timestamp when the feed item was interacted with. - `link_clicked_at` string, nullable — Timestamp when a link within the feed item was clicked. - `read_at` string, nullable — Timestamp when the feed item was marked as read. - `seen_at` string, nullable — Timestamp when the feed item was marked as seen. - `source` object, required — Source information for the feed item. - `__typename` string, required — The typename of the schema. - `categories` string[], required — Categories this workflow belongs to. - `key` string, required — The key of the workflow. - `version_id` string, uuid, required — The workflow version ID. - `tenant` string, nullable, required — Tenant ID that the feed item belongs to. - `total_activities` integer, required — Total number of activities related to this feed item. - `total_actors` integer, required — Total number of actors related to this feed item. - `updated_at` string, required — The timestamp when the resource was last updated. - `meta` object, required — The metadata for the user's feed. - `__typename` string, required — The typename of the schema. - `total_count` integer, required — The total number of feed items in the user's feed. - `unread_count` integer, required — The number of unread feed items in the user's feed. - `unseen_count` integer, required — The number of unseen feed items in the user's feed. - `page_info` PageInfo, required — Pagination information for a list of resources. - `__typename` string, required — The typename of the schema. - `after` string, nullable — The cursor to fetch entries after. - `before` string, nullable — The cursor to fetch entries before. - `page_size` integer, required — The number of items per page (defaults to 50). - `vars` object, required — Additional variables for the feed item. --- [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)