List Contacts

Retrieve a paginated list of all contacts in your workspace.

Use Cases:

• Export your entire contact database
• Build custom contact management dashboards
• Sync contacts with external CRM systems
• Generate contact reports and analytics
• Display contact lists in your application

Behavior:

• Returns contacts in reverse chronological order (newest first)
• Uses cursor-based pagination for efficient data retrieval
• Includes all contact properties (default and custom)
• Includes subscription status and topic memberships
• Maximum 100 contacts per request (use 'limit' parameter)
• Deleted contacts are not included in results

Required Scope: read:contacts

Pagination:

• Use 'after' cursor to fetch the next page
• Use 'before' cursor to fetch the previous page
• Response includes 'hasMore' and 'hasPrevious' flags
• Cursors are based on contact IDs for stable pagination

Performance Tips:

• Use the maximum limit (100) for bulk exports
• Cache results when possible to reduce API calls
• For filtered results, use the /v1/contacts/search endpoint instead