Preview a saved segment's matching contacts

GET
/v1/segments/{id}/preview

Oldest-first keyset page over (created_at, id) of contacts matching the segment's compiled filter.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <key>. Looked up by SHA-256 hash (email_core::sha256_hex) against api_keys.hash; revoked keys and keys belonging to a suspended tenant are rejected. See the top-level Authentication section for permission levels.

Path Parameters

id*string

Query Parameters

limit?integer

Max rows to return.

Range1 <= value <= 100
Default25
cursor?string

Response Body

Matching contacts.

application/json
  1. response
data?array<>
next_cursor?string|null
curl -X GET "https://example.com/v1/segments/string/preview"
{  "data": [    {      "id": "string",      "email": "user@example.com",      "status": "subscribed",      "attributes": {},      "source": "string",      "created_at": 0,      "updated_at": 0    }  ],  "next_cursor": "string"}