SmartLead icon

SmartLead

Interact with SmartLead API (campaigns, leads, inbox, analytics, delivery, and webhooks)

Actions144

Master Inbox → Get Custom View Emails

AI-generated

Summary

Fetch custom view email messages from the Master Inbox, optionally with pagination controls.

Inputs

  • returnAll — When true, returns all matching emails without a limit; when false, respects limit and pagination settings.
  • limit — Maximum number of email records to return per page; ignored if returnAll is true.
  • pageSize — Number of items per page when fetching all pages; used with returnAll true to control batch size.
  • offset — Zero‑based offset for pagination; indicates where to start the next page of results.
  • requestBody — JSON payload used to define filters or parameters for the custom view query.
  • requestOptions — Additional request settings such as batching, SSL validation, proxy, and timeout.

Output shape

a paginated array of custom view email records

The response includes a data array of emails and pagination metadata (e.g., hasMore). The shape may vary based on request parameters; pagination fields are optional.

Examples

Example 1: Retrieve the first page of custom view emails with default pagination

{"resource":"Master Inbox","operation":"Get Custom View Emails","returnAll":false,"limit":50,"pageSize":100,"offset":0,"requestBody":{}}

Example 2: Fetch next page using offset and limit

{"resource":"Master Inbox","operation":"Get Custom View Emails","returnAll":false,"limit":100,"pageSize":100,"offset":100,"requestBody":{}}

Example 3: Retrieve all emails using returnAll

{"resource":"Master Inbox","operation":"Get Custom View Emails","returnAll":true,"limit":50,"pageSize":100,"offset":0,"requestBody":{}}

Links

Discussion