Parallel AI icon

Parallel AI

Interact with Parallel AI

Actions537

Inbox → List Inboxes

AI-generated

Summary

List inboxes belonging to a specified company, supporting pagination and optional search filtering by name or email.

Inputs

  • Company ID (required) — The identifier of the company whose inboxes should be listed.
  • Page — Page number to fetch, for pagination (default is 0).
  • Page Size — Number of inbox items to return per page (default is 0, meaning API default).
  • Query — Search string to filter inboxes by name or email.

Output shape

a list of inbox records

Returns a paginated list of inbox objects filtered by the supplied company ID and optional query. Pagination parameters control the page number and page size. The inbox objects include their details as provided by the Parallel AI API.

Examples

Example 1: Fetch first 10 inboxes for company ABC with no filter

Company ID set to ABC, Page to 0, Page Size to 10, Query left empty.

Example 2: Search inboxes with 'support' in name or email on second page

Company ID set to the target company, Page set to 1, Query set to 'support'.

Links

Discussion