persons_get_collection
Fetch persons using cursor-based pagination for efficient large-scale data synchronization, with optional date range and owner filters.
Instructions
Get all persons using the collection endpoint.
This endpoint provides an alternative way to fetch persons with different capabilities:
Cursor-based pagination (more efficient for large datasets)
Date range filtering (since/until)
Optimized for data synchronization
Better performance for large-scale operations
Key differences from persons_list:
Uses cursor pagination instead of offset/limit
Supports date-based filtering for incremental sync
More efficient for fetching large volumes
Better for ETL and data integration scenarios
Parameters:
cursor: Pagination cursor from previous response
limit: Items per page (default: 100, max: 500)
since: Start date (YYYY-MM-DD) - get persons modified since this date
until: End date (YYYY-MM-DD) - get persons modified until this date
owner_id: Filter by owner user ID
first_char: Filter by first character of name
Use cases:
Initial data synchronization
Incremental updates (using since parameter)
Large-scale data exports
Integration with external systems
ETL pipelines
Backup and archival
The cursor-based approach is more reliable than offset pagination for datasets that change frequently, as it maintains consistency even when records are added or deleted during pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Cursor for pagination (from previous response) | |
| limit | No | Number of items to return (default: 100, max: 500) | |
| since | No | Start date for filtering (YYYY-MM-DD format) | |
| until | No | End date for filtering (YYYY-MM-DD format) | |
| owner_id | No | Filter by owner user ID | |
| first_char | No | Filter by first character of name (single letter) |