Skip to main content

getMessages

client.inbox.getMessages(params?: InboxMessageListParams): Promise<InboxMessage[]>

Retrieves all inbox messages.

Returns the full list of messages in the inbox, including unread, acknowledged, and unresolved messages. Use optional parameters to filter by status or paginate results.

Parameters

ParameterTypeRequiredDescription
paramsInboxMessageListParamsNoOptional query and filter parameters

Returns

Promise<InboxMessage[]> — A promise that resolves to an array of objects

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.inbox.getMessages();
console.log(result);