Segments
Preview segment results
A paginated preview of the entities currently matched by the segment filter's query, computed on demand (without persisting results). Each item is a JSON:API resource for the segment's entity (a person or organization), not a segment result record. Returns 422 if the segmentation query is invalid.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
include?string
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
page?
Offset pagination parameters.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/segment_filters/497f6eca-6276-4993-bfeb-53cbbbba6f08/preview_results"{ "data": [ {} ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}