Section ID:
DOC-API-MODEL-schema-ojrenemkui#overview
InboxFeedFilter
Read-state, category, tag, and archive criteria selecting inbox entries.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ojrenemkui#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ojrenemkui#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-ojrenemkui#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ojrenemkui#field-unseenonlySection ID: DOC-API-MODEL-schema-ojrenemkui#request-field-unseenonlyunseenOnly | boolean | Optional | Whether the inbox filter selects only unseen messages. |
Section ID: DOC-API-MODEL-schema-ojrenemkui#field-unreadonlySection ID: DOC-API-MODEL-schema-ojrenemkui#request-field-unreadonlyunreadOnly | boolean | Optional | Whether the inbox filter selects only unread messages. |
Section ID: DOC-API-MODEL-schema-ojrenemkui#field-feedidsSection ID: DOC-API-MODEL-schema-ojrenemkui#request-field-feedidsfeedIds | Array of string | Optional | Filter by Novu feed identifiers. |
Section ID: DOC-API-MODEL-schema-ojrenemkui#field-categoriesSection ID: DOC-API-MODEL-schema-ojrenemkui#request-field-categoriescategories | Array of string | Optional | Categories used to select inbox messages. |
tags | Array of string | Optional | Filter by workflow tags (OR logic per Novu semantics). |
Section ID: DOC-API-MODEL-schema-ojrenemkui#field-archivedSection ID: DOC-API-MODEL-schema-ojrenemkui#request-field-archivedarchived | boolean | Optional | When true, include archived messages. False or omission selects the live inbox and excludes archived messages. |
Where used
Section ID: DOC-API-MODEL-schema-ojrenemkui#where-used
| Reference | Relationship |
|---|---|
| Get inbox feed messages | POST /api/v1/notifications/get-inbox-feed |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ojrenemkui