SmartLead icon

SmartLead

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

Actions144

Client → List

AI-generated

Summary

Fetches a paginated list of clients from the SmartLead account.

Inputs

  • returnAll — Whether to fetch all results in a single execution or use pagination to fetch them in chunks.
  • limit — Max number of results to return when returnAll is false. Defaults to 50.
  • pageSize — Page size used while fetching all pages when returnAll is true. Defaults to 100.
  • offset — Offset for paginated list operations to skip a specific number of results.
  • queryParameters — Additional query-string parameters as a JSON object.
  • requestOptions — Options for batching requests, SSL certificate validation, proxy, and timeout.

Output shape

A list of client items.

The operation supports pagination. When returnAll is false, it returns up to the specified limit. When returnAll is true, it automatically paginates through all pages.

Examples

Example 1: Fetch up to 100 clients without pagination

Set returnAll to false, limit to 100, and leave other parameters as defaults.

Example 2: Fetch all clients across multiple pages

Set returnAll to true and pageSize to 100.

Links

Discussion