Get inbox feed messages

POST 
/api/v1/notifications/get-inbox-feed

Returns a paginated list of in-app inbox messages for the authenticated user, applying the supplied selection criteria.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Build an in-app inbox

Request

Responses

200

Inbox feed retrieved successfully

Read the selected user’s inbox using default paging and filters.

Section ID: DOC-CP-notifications-api-getInboxFeed#example-notifications-getInboxFeed-request

Request example

{}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.

Section ID: DOC-CP-notifications-api-getInboxFeed#example-notifications-getInboxFeed-response

Response example

{
  "messages": [
    {
      "messageId": "example_123",
      "notificationId": "example_123",
      "title": "example",
      "body": "example",
      "data": {},
      "deepLink": "example",
      "imageUrl": "https://example.com/resource",
      "status": "MESSAGE_STATUS_UNSEEN",
      "category": "example",
      "createdAt": "2026-09-16T12:00:00Z",
      "seenAt": "2026-09-16T12:00:00Z",
      "readAt": "2026-09-16T12:00:00Z",
      "actions": [
        {
          "actionId": "example_123",
          "label": "example",
          "url": "https://example.com/resource",
          "isPrimary": true,
          "completed": true
        }
      ],
      "tags": [
        "example"
      ],
      "archived": true,
      "archivedAt": "2026-09-16T12:00:00Z"
    }
  ],
  "totalCount": 1,
  "page": 1,
  "pageSize": 1,
  "hasMore": true
}

Document ID: DOC-CP-notifications-api-getInboxFeed. Section identities and revisions.

Section	Stable reference
Get inbox feed messages	DOC-CP-notifications-api-getInboxFeed#overview
Request	DOC-CP-notifications-api-getInboxFeed#request
Responses	DOC-CP-notifications-api-getInboxFeed#responses