Paging through data and bulk sync

This page is for integrations that read Vaam data at scale — reporting pipelines, warehouse syncs, or custom agents that need full history.

Pagination

All list tools use cursor pagination:

• limit — items per page, default 20, maximum 100.
• cursor — pass the nextCursor from the previous page to fetch the next one.

Responses contain items, nextCursor, and hasMore. Keep requesting with the returned cursor until hasMore is false. Ordering is newest-first by creation time and stays stable across pages.

Syncing outreach history

To sync each prospect’s progress through your sequences, call list_enrollments with includeDetails: true:

{ "limit": 100, "includeDetails": true }

With includeDetails, every item carries the prospect’s contact info (prospectInfo) and step-by-step progress (stepProgress) in addition to the summary fields — so you do not need a follow-up get_enrollment call per item. A history of a few thousand prospects syncs in a few dozen requests, comfortably within the rate limits.

Listing without a sequenceId filter returns progress across all sequences — including sequences that have since been deleted. That is intentional: your history stays complete even after you clean up old sequences.

How counts are calculated

Two tools report numbers, and they measure different things:

• get_stats counts your prospects’ sequence runs directly, per status (active, paused, completed, queued, canceled, messageReceived), plus a total. These counts include runs in sequences that were later deleted, and total also includes short-lived waiting states — so the listed statuses may not sum exactly to total.
• list_sequences returns a stats object per sequence. These are per-sequence counters that include everyone on your team who used that sequence, bucketed by sequence step state (active, done, paused, queued, waiting).

Because of that, summing list_sequences stats will not match get_stats — deleted sequences are excluded from the list, and team members’ prospects are included in sequence counters. For your own numbers, always use get_stats.