Segments
GET
Get Segment Contacts
GET /v1/segments/{segmentId}/contactsRetrieve all contacts that match a segment's filter conditions.
Use Cases:
- Export contacts from a specific segment
- Verify segment membership before campaigns
- Build segment-based reports
- Preview segment membership
- Test segment conditions with real data
Behavior:
- Returns contacts matching segment's conditions in real-time
- Uses cursor-based pagination for efficient retrieval
- Results are evaluated dynamically (always current)
- Maximum 100 contacts per request
- Includes all contact properties and metadata
- Sorted by contact creation date (newest first)
Required Scope: read:contacts and read:segments
Response Includes:
- Complete contact objects with all properties
- Subscription statuses and topic memberships
- Contact metadata (createdAt, updatedAt)
- Pagination cursors for navigation
Use Cases:
- Send targeted campaigns to segment members
- Export segment data for analysis
- Verify segment conditions are working correctly
- Build custom reports on segment members
Note: This endpoint evaluates conditions in real-time, so membership reflects current contact data, not cached counts.
Path parameters
segmentIdstringrequiredSegment ID
Query parameters
limitintegerNumber of items to return (default: 20, max: 100)
afterstringCursor for pagination - ID of the last item from the previous page
beforestringCursor for reverse pagination - ID of the first item from the next page
Response
200Successfully retrieved contacts matching the segment's conditions with complete contact data and metadata
objectstringrequiredhasMorebooleanrequireddataobject[]required