Parallel AI icon

Parallel AI

Interact with Parallel AI

Actions537

Inbox → List All Messages

AI-generated

Summary

Retrieve a paginated list of all messages from an inbox within a specified company, optionally filtering by search query, message types, and specific inbox IDs.

Inputs

  • Company ID (required) — The identifier of the company whose inbox messages you want to list.
  • Page — The page number to retrieve; used for pagination.
  • Page Size — The number of messages to retrieve per page.
  • Query — A search string to filter messages by content or metadata.
  • Message Types — Comma-separated list of message types to include, such as received, sent_compose, sent_reply, and draft.
  • Inbox IDs — Comma-separated list of inbox IDs to filter the messages by specific inboxes.

Output shape

a paginated list of message objects for the specified company inbox

The response includes messages matching the provided filters, segmented by page and page size parameters. If no filters are provided, returns messages unfiltered for the specified company. Results depend on the API's underlying pagination and filtering capabilities.

Links

Discussion