Run a campaign segment query (preview)
Return a page of contacts that match the segment’s saved rules. The segment preview table uses this with $skip / $limit for pagination.
Endpoint
POST/contacts-segments-run-query
Request
Use $limit at most 50 to align with product pagination rules.
Response
json
Field names on each row follow your API version (the UI maps contact_id, names, email, phone).
Body fields
| Field | Type | Description |
|---|---|---|
campaign_segment_id | Number | Segment whose stored query should be executed. |
organization_id | Number | Organization id. |
$skip | Number | Pagination offset. |
$limit | Number | Page size (max 50). |
Report an issue with this documentation
Please log in to report issues with our documentation.