Pumble API icon

Pumble API

Interact with the Pumble API

Message → List

AI-generated

Summary

List messages in a channel, returning an array of message objects.

Inputs

  • channelIdentType (required) — Whether to identify the channel by its ID or name. Options: Channel ID (value: channelId), Channel Name (value: channel). Default: Channel ID.
  • channelId — The unique ID of the channel. Required when channelIdentType is set to Channel ID. If omitted, no channel identifier is sent via ID.
  • channelName — The name of the channel. Required when channelIdentType is set to Channel Name. If omitted, no channel identifier is sent via name.
  • listOptions — Additional options for the list request. A collection where each added option contributes a query string parameter. The collection initially contains no options and can be expanded with Cursor, Limit, Strategy.
  • listOptions.cursor — Pagination cursor used to fetch the next page of results. Type: string. Default: empty string.
  • listOptions.limit — Maximum number of messages to return per request. Type: number. Default: 50.
  • listOptions.strategy — Strategy to apply when listing messages. Type: string. Default: empty string.

Output shape

array

Each element of the array corresponds to a message object as returned by the Pumble API. If the API returns a non-array response, it is wrapped in an array by the node's execution logic.

Examples

Example 1: Fetch the most recent 50 messages from a channel using its ID

Set Resource to Message, Operation to List, Channel Identifier Type to Channel ID, Channel ID to the desired ID, leave listOptions empty or adjust Limit as needed.

Example 2: Page through messages using a cursor

After an initial list call, capture the cursor value from the response (if provided) and set listOptions.Cursor to that value for the next request, keeping Limit unchanged.

Links

Discussion